Send Templated Email with Amazon SES API on New Document Updated (Instant) from DocumentPro API

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

Trigger workflow on

New Document Updated (Instant) from the DocumentPro API

Next, do this

Send Templated Email 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 DocumentPro 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 Document Updated (Instant) trigger
1. Connect your DocumentPro account
2. Select a Parser ID
Configure the Send Templated Email action
1. Connect your Amazon SES account
2. Select a AWS Region
3. Configure To Addresses
4. Optional- Configure CC Addresses
5. Optional- Configure BCC Addresses
6. Optional- Configure Reply To Addresses
7. Configure From
8. Select a Template Name
9. Configure Template Data
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 Document Updated (Instant) on DocumentPro

Description:Emit new event when a file request status changes. You can only create one webhook in a parser at a time.

Version:0.0.1

Key:documentpro-new-document-updated-instant

View on GitHub

Trigger Code#

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

export default {
  key: "documentpro-new-document-updated-instant",
  name: "New Document Updated (Instant)",
  description: "Emit new event when a file request status changes. You can only create one webhook in a parser at a time.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    documentpro,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    parserId: {
      propDefinition: [
        documentpro,
        "parserId",
      ],
    },
  },
  hooks: {
    async activate() {
      await this.documentpro.updateParser({
        parserId: this.parserId,
        data: {
          webhook_url: this.http.endpoint,
        },
      });
    },
    async deactivate() {
      await this.documentpro.updateParser({
        parserId: this.parserId,
        data: {
          webhook_url: null,
        },
      });
    },
  },
  async run({ body }) {
    this.$emit(body, {
      id: `${body.data.request_id}-${body.timestamp}`,
      summary: `New document (${body.data.response_body.file_name}) status updated: ${body.event} - ${body.data.request_status}`,
      ts: Date.parse(body.timestamp),
    });

    this.http.respond({
      status: 200,
      body: {
        message: "Received",
      },
    });
  },
  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
DocumentPro	`documentpro`	`app`	This component uses the DocumentPro 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.
Parser ID	`parserId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About DocumentPro#

Automate data extraction with AI parsers. Extract Invoices from PDFs and Images to Excel & more using AI.

Action#

Send Templated Email on Amazon SES

Description:Send an email replacing the template tags with values using Amazon SES. [See the docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ses/classes/sendtemplatedemailcommand.html)

Version:0.0.1

Key:amazon_ses-send-templated-email

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-send-templated-email",
  name: "Send Templated Email",
  description: "Send an email replacing the template tags with values using Amazon SES. [See the docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-ses/classes/sendtemplatedemailcommand.html)",
  version: "0.0.1",
  type: "action",
  props: {
    ...base.props,
    ToAddresses: {
      propDefinition: [
        base.props.amazonSes,
        "ToAddresses",
      ],
    },
    CcAddresses: {
      propDefinition: [
        base.props.amazonSes,
        "CcAddresses",
      ],
    },
    BccAddresses: {
      propDefinition: [
        base.props.amazonSes,
        "BccAddresses",
      ],
    },
    ReplyToAddresses: {
      propDefinition: [
        base.props.amazonSes,
        "ReplyToAddresses",
      ],
    },
    FromEmailAddress: {
      propDefinition: [
        base.props.amazonSes,
        "FromEmailAddress",
      ],
    },
    Template: {
      propDefinition: [
        base.props.amazonSes,
        "TemplateName",
        (c) => ({
          region: c.region,
        }),
      ],
    },
    TemplateData: {
      type: "object",
      label: "Template Data",
      description: "A JSON object of replacement values to apply to the template tags",
    },
  },
  async run({ $ }) {
    const params = {
      Destination: {
        ToAddresses: this.ToAddresses,
        CcAddresses: this.CcAddresses,
        BccAddresses: this.BccAddresses,
      },
      Source: this.FromEmailAddress,
      ReplyToAddresses: this.ReplyToAddresses,
      Template: this.Template,
      TemplateData: JSON.stringify(this.TemplateData),
    };

    const response = await this.amazonSes.sendTemplatedEmail(this.region, params);
    $.export("$summary", "Sent email successfully");
    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.
To Addresses	`ToAddresses`	`string[]`	An array of recipient email addresses you want to send to
CC Addresses	`CcAddresses`	`string[]`	An array of email addresses you want to CC
BCC Addresses	`BccAddresses`	`string[]`	An array of email addresses you want to BCC
Reply To Addresses	`ReplyToAddresses`	`string[]`	An array of reply-to addresses
From	`FromEmailAddress`	`string`	The email from which the email is addressed
Template Name	`Template`	`string`	Select a value from the drop down menu.
Template Data	`TemplateData`	`object`	A JSON object of replacement values to apply to the template tags

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.