Update Email Template with Amazon SES API on New Topic Webhook from QStash API

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

Trigger workflow on

New Topic Webhook from the QStash 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 QStash 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 Topic Webhook trigger
1. Connect your QStash account
2. Select a QStash Topic
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 Topic Webhook on QStash

Description:Emit new events on each new QStash topic message

Version:0.0.1

Key:qstash-new-topic-webhook

View on GitHub

QStash Overview#

QStash API offers a secure, scalable, and simple way to manage message queues and defer tasks. Using this API, you can enqueue messages, schedule tasks to run after a delay, and ensure that tasks are executed exactly once, leveraging the power of serverless architecture. With Pipedream's ability to connect to a multitude of services, you can build complex workflows that trigger actions in other apps based on events in QStash, allowing you to automate cross-application business processes with ease.

Trigger Code#

import qstash from "../../qstash.app.mjs";
import { methods } from "../../common.mjs";

export default {
  name: "New Topic Webhook",
  version: "0.0.1",
  key: "qstash-new-topic-webhook",
  description: "Emit new events on each new QStash topic message",
  props: {
    qstash,
    topicId: {
      type: "string",
      label: "QStash Topic",
      description: "The QStash topic to subscribe to.",
      async options() {
        const topics = await this.qstash.listTopics({
          $: this,
        });

        return topics.map((topic) => ({
          label: topic.name,
          value: topic.topicId,
        }));
      },
    },
    http: {
      type: "$.interface.http",
      customResponse: true, // optional: defaults to false
    },
    db: "$.service.db",
  },
  type: "source",
  methods: {
    ...methods,
  },
  hooks: {
    async deploy() {
      console.log("deployment hook started");
      console.log("selected topic ID", this.topicId);
      console.log(`PD generated endpoint URL ${this.http.endpoint}`);
      const endpoint = await this.qstash.createEndpoint({
        $: this,
        topicId: this.topicId,
        endpointUrl: this.http.endpoint,
      });
      console.log("Created endpoint", endpoint);
      this.db.set("endpointId", endpoint.endpointId);
    },
    async deactivate() {
      console.log("deactivate hook started");
      const endpointId = this.db.get("endpointId");
      await this.qstash.deleteEndpoint({
        $: this,
        endpointId,
      });
      console.log(`Deleted QStash endpoint ${endpointId}`);
    },
    async activate() {
      console.log("activate hook started");

      const keys = await this.qstash.getKeys({
        $: this,
      });

      const currentSigningKey = keys.current;
      const nextSigningKey = keys.next;

      this.db.set("currentSigningKey", currentSigningKey);
      this.db.set("nextSigningKey", nextSigningKey);
      console.log("Set QStash signing keys");
    },
  },
  async run(event) {
    const signature = event.headers["upstash-signature"];
    const currentSigningKey = this.db.get("currentSigningKey");
    const nextSigningKey = this.db.get("nextSigningKey");
    const url = event.url.slice(0, -1);

    try {
      await this.verify(signature, currentSigningKey, event.rawBody, url);
    } catch (e) {
      console.log(e);
      await this.verify(signature, nextSigningKey, event.rawBody, url);
    }

    await this.$emit(
      {
        event,
      },
      {
        id: event.headers["upstash-signature"],
        summary: "New webhook received from QStash",
        ts: Date.now(),
      },
    );

    await this.http.respond({
      status: 200,
    });
  },
};

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
QStash	`qstash`	`app`	This component uses the QStash app.
QStash Topic	`topicId`	`string`	Select a value from the drop down menu.
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.

Trigger Authentication#

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

Retrieve your QStash token

Open the QStash console
Copy the QSTASH_TOKEN from the Request Builder

Click REQUEST_TOKEN within the Request builder to copy the token to your clipboard

Then paste it in the field below.

About QStash#

QStash is an HTTP based messaging and scheduling solution for the serverless and edge runtimes.

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.