Update Email Template with Amazon SES API on New Webhook Event (Instant) from Heroku API

Pipedream makes it easy to connect APIs for Amazon SES, Heroku and 2,400+ other apps remarkably fast.

Trigger workflow on

New Webhook Event (Instant) from the Heroku API

Next, do this

Update Email Template with the Amazon SES API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Heroku trigger and Amazon SES action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Webhook Event (Instant) trigger
1. Connect your Heroku account
2. Select a App ID
3. Select one or more Entities
Configure the Update Email Template action
1. Connect your Amazon SES account
2. Select a AWS Region
3. Select a Template Name
4. Optional- Configure Subject
5. Optional- Configure HTML
6. Optional- Configure Text
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Webhook Event (Instant) on Heroku

Description:Emit new event on each webhook event. [See the documentation](https://devcenter.heroku.com/articles/app-webhooks-schema#webhook-create)

Version:0.0.1

Key:heroku-new-webhook-event-instant

View on GitHub

Heroku Overview#

The Heroku API offers programmatic access to Heroku's cloud platform, enabling developers to automate, extend, and integrate their app's lifecycle events with other services. With Pipedream, you can harness the Heroku API for powerful automation, such as managing apps, dynos, add-ons, and configuring scaling operations. Pipedream's ability to connect with multiple services allows for creating complex workflows, such as syncing your development pipeline with external project management tools or triggering alerts based on app metrics.

Trigger Code#

import heroku from "../../heroku.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "heroku-new-webhook-event-instant",
  name: "New Webhook Event (Instant)",
  description: "Emit new event on each webhook event. [See the documentation](https://devcenter.heroku.com/articles/app-webhooks-schema#webhook-create)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    heroku,
    http: "$.interface.http",
    db: "$.service.db",
    appId: {
      propDefinition: [
        heroku,
        "appId",
      ],
    },
    entities: {
      propDefinition: [
        heroku,
        "entities",
      ],
    },
  },
  hooks: {
    async activate() {
      const { id } = await this.heroku.createWebhookSubscription({
        appId: this.appId,
        data: {
          include: this.entities,
          level: "notify",
          url: this.http.endpoint,
        },
      });
      this._setHookId(id);
    },
    async deactivate() {
      const hookId = this._getHookId();
      if (hookId) {
        await this.heroku.deleteWebhookSubscription({
          appId: this.appId,
          hookId,
        });
      }
    },
  },
  methods: {
    _getHookId() {
      return this.db.get("hookId");
    },
    _setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
    generateMeta(event) {
      return {
        id: event.id,
        summary: `New ${event.webhook_metadata.event.include} - ${event.action} Event`,
        ts: Date.now(),
      };
    },
  },
  async run(event) {
    const { body } = event;
    if (!body) {
      return;
    }
    const meta = this.generateMeta(body);
    this.$emit(body, meta);
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Heroku	`heroku`	`app`	This component uses the Heroku app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
App ID	`appId`	`string`	Select a value from the drop down menu.
Entities	`entities`	`string[]`	Select a value from the drop down menu:`{ "value": "api:addon-attachment", "label": "addon-attachment - An add-on has been attached or removed from the app" }{ "value": "api:addon", "label": "addon - An add-on for the app has been newly provisioned or deleted, or its details have been modified" }{ "value": "api:app", "label": "app - The app itself has been provisioned or deleted, or its details have been modified" }{ "value": "api:build", "label": "build - A new build for the app has been initiated or the build’s status has changed since the last notification" }{ "value": "api:collaborator", "label": "collaborator - A collaborator has been added or removed from the app, or an existing collaborator’s details have been modified" }{ "value": "api:domain", "label": "domain - Custom domain details have been added or removed from the app" }{ "value": "api:dyno", "label": "dyno - A new dyno has begun running for the app" }{ "value": "api:formation", "label": "formation - The dyno formation for a particular process type has been modified" }{ "value": "api:release", "label": "release - A new release for the app has been initiated or the release’s status has changed since the last notification" }{ "value": "api:sni-endpoint", "label": "sni-endpoint - An SNI endpoint has been specified or removed for the app, or the existing SNI endpoint’s details have been modified" }`

Trigger Authentication#

Heroku uses OAuth authentication. When you connect your Heroku account, Pipedream will open a popup window where you can sign into Heroku and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Heroku API.

Pipedream requests the following authorization scopes when you connect your account:

global

About Heroku#

Cloud infrastructure

Action#

Update Email Template on Amazon SES

Description:Update an email template. [See the docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sesv2/classes/updateemailtemplatecommand.html)

Version:0.0.1

Key:amazon_ses-update-email-template

View on GitHub

Amazon SES Overview#

Amazon Simple Email Service (SES) is a powerful cloud-based email sending service designed to help digital marketers and application developers send marketing, notification, and transactional emails. With the SES API, you can reliably send emails at scale, manage sender reputations, view email sending statistics, and maintain a high deliverability rate. Leveraging Pipedream's capabilities, you can integrate SES seamlessly into serverless workflows, automate email responses based on triggers from other apps, and analyze the effectiveness of your email campaigns by connecting to data analytics platforms.

Action Code#

import base from "../common/base.mjs";

export default {
  key: "amazon_ses-update-email-template",
  name: "Update Email Template",
  description: "Update an email template. [See the docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sesv2/classes/updateemailtemplatecommand.html)",
  version: "0.0.1",
  type: "action",
  props: {
    ...base.props,
    TemplateName: {
      propDefinition: [
        base.props.amazonSes,
        "TemplateName",
        (c) => ({
          region: c.region,
        }),
      ],
    },
    Subject: {
      propDefinition: [
        base.props.amazonSes,
        "Subject",
      ],
      optional: true,
    },
    Html: {
      propDefinition: [
        base.props.amazonSes,
        "Html",
      ],
      optional: true,
    },
    Text: {
      propDefinition: [
        base.props.amazonSes,
        "Text",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const { TemplateContent } = await this.amazonSes.getEmailTemplate(this.region, {
      TemplateName: this.TemplateName,
    });

    const params = {
      TemplateName: this.TemplateName,
      TemplateContent: {
        Subject: this.amazonSes.replaceCurlyBrackets(this.Subject) ?? TemplateContent.Subject,
        Html: this.amazonSes.replaceCurlyBrackets(this.Html) ?? TemplateContent.Html,
        Text: this.amazonSes.replaceCurlyBrackets(this.Text) ?? TemplateContent.Text,
      },
    };

    const response = await this.amazonSes.updateEmailTemplate(this.region, params);
    $.export("$summary", "Successfully updated email template");
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Amazon SES	`amazonSes`	`app`	This component uses the Amazon SES app.
AWS Region	`region`	`string`	Select a value from the drop down menu.
Template Name	`TemplateName`	`string`	Select a value from the drop down menu.
Subject	`Subject`	`string`	The email subject line. Use `\{\{` and `\}\}` to insert tags. Example: `This is a \{\{tagname\}\}`.
HTML	`Html`	`string`	The HTML email body. Use `\{\{` and `\}\}` to insert tags. Example: `This is a \{\{tagname\}\}`.
Text	`Text`	`string`	The email body that will be visible to recipients whose email clients do not display HTML. Use `\{\{` and `\}\}` to insert tags. Example: `This is a \{\{tagname\}\}`.

Action Authentication#

Amazon SES uses API keys for authentication. When you connect your Amazon SES account, Pipedream securely stores the keys so you can easily authenticate to Amazon SES APIs in both code and no-code steps.

Follow the AWS Instructions for creating an IAM user with an associated access and secret key, with the minimum IAM permissions necessary to send email or hit the desired SES APIs from Pipedream.

Enter the access and secret key below.