Update Email Template with Amazon SES API on New Merged Document (Instant) from DocuMerge API

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

Trigger workflow on

New Merged Document (Instant) from the DocuMerge 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 DocuMerge 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 Merged Document (Instant) trigger
1. Connect your DocuMerge account
2. Select one or more Document IDs
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 Merged Document (Instant) on DocuMerge

Description:Emit new event when a merged document is created in documerge.

Version:0.0.1

Key:documerge-new-merged-document-instant

View on GitHub

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "documerge-new-merged-document-instant",
  name: "New Merged Document (Instant)",
  description: "Emit new event when a merged document is created in documerge.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    documentIds: {
      propDefinition: [
        common.props.documerge,
        "documentId",
      ],
      type: "string[]",
      label: "Document IDs",
      description: "An array of document identifiers of the documents to watch",
    },
  },
  hooks: {
    async activate() {
      const deliveryMethodIds = {};
      for (const documentId of this.documentIds) {
        const { data: { id } } = await this.documerge.createDocumentDeliveryMethod({
          documentId,
          data: this.getWebhookSettings(),
        });
        deliveryMethodIds[documentId] = id;
      }
      this._setDeliveryMethodIds(deliveryMethodIds);
    },
    async deactivate() {
      const deliveryMethodIds = this._getDeliveryMethodIds();
      for (const documentId of this.documentIds) {
        await this.documerge.deleteDocumentDeliveryMethod({
          documentId,
          deliveryMethodId: deliveryMethodIds[documentId],
        });
      }
      this._setDeliveryMethodIds({});
    },
  },
  methods: {
    ...common.methods,
    getSummary(body) {
      return `Merged Document: ${body.file_name}`;
    },
  },
  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
DocuMerge	`documerge`	`app`	This component uses the DocuMerge 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.
Document IDs	`documentIds`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

About DocuMerge#

Automated Document Generation.

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.