Send Document Using Template with BoldSign API on New Inbound SES Emails from AWS API

Pipedream makes it easy to connect APIs for BoldSign, AWS and 2,400+ other apps remarkably fast.

Trigger workflow on

New Inbound SES Emails from the AWS API

Next, do this

Send Document Using Template with the BoldSign 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 AWS trigger and BoldSign action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Inbound SES Emails trigger
1. Connect your AWS account
2. Select a AWS Region
3. Select a SES Domain
Configure the Send Document Using Template action
1. Connect your BoldSign account
2. Select a Template ID
3. Optional- Configure Title
4. Optional- Configure Message
5. Configure Roles
6. Optional- Select a Brand ID
7. Optional- Configure Labels
8. Optional- Configure Disable Emails
9. Optional- Configure Disable SMS
10. Optional- Configure Hide Document ID
11. Optional- Configure Enable Auto Reminder
12. Optional- Configure Reminder Days
13. Optional- Configure Reminder Count
14. Optional- Select one or more CC
15. Optional- Configure Expiry Days
16. Optional- Configure Enable Print and Sign
17. Optional- Configure Enable Reassign
18. Optional- Configure Enable Signing Order
19. Optional- Configure Disable Expiry Alert
20. Optional- Configure Document Info
21. Optional- Configure Role Removal Indices
22. Optional- Select a Document Download Option
23. Optional- Configure Form Groups
24. Optional- Configure Files
25. Optional- Configure File URLs
26. Optional- Configure Recipient Notification Settings
27. Optional- Configure Remove Formfields
28. Optional- Configure Enable Audit Trail Localization
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 Inbound SES Emails on AWS

Description:The source subscribes to all emails delivered to a specific domain configured in AWS SES. When an email is sent to any address at the domain, this event source emits that email as a formatted event. These events can trigger a Pipedream workflow and can be consumed via SSE or REST API.

Version:1.2.4

Key:aws-new-emails-sent-to-ses-catch-all-domain

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Trigger Code#

import { v4 as uuid } from "uuid";
import base from "../common/ses.mjs";
import commonS3 from "../../common/common-s3.mjs";
import { toSingleLineString } from "../../common/utils.mjs";
import { simpleParser } from "mailparser";

export default {
  ...base,
  key: "aws-new-emails-sent-to-ses-catch-all-domain",
  name: "New Inbound SES Emails",
  description: toSingleLineString(`
    The source subscribes to all emails delivered to a
    specific domain configured in AWS SES.
    When an email is sent to any address at the domain,
    this event source emits that email as a formatted event.
    These events can trigger a Pipedream workflow and can be consumed via SSE or REST API.
  `),
  type: "source",
  version: "1.2.4",
  props: {
    ...base.props,
    domain: {
      label: "SES Domain",
      description: "The domain you'd like to configure a catch-all handler for",
      type: "string",
      async options() {
        const { Identities: identities } = await this.listIdentities();
        return identities;
      },
    },
  },
  methods: {
    ...base.methods,
    ...commonS3.methods,
    getReceiptRule(bucketName, topicArn) {
      const name = `pd-catchall-${uuid()}`;
      const rule = {
        Name: name,
        Enabled: true,
        Actions: [
          {
            S3Action: {
              TopicArn: topicArn,
              BucketName: bucketName,
            },
          },
        ],
        Recipients: [
          this.domain,
        ],
        ScanEnabled: true,
      };
      return {
        name,
        rule,
      };
    },
    async processEvent(event) {
      const { body } = event;
      const { Message: rawMessage } = body;
      if (!rawMessage) {
        console.log("No message present, exiting");
        return;
      }

      const { "x-amz-sns-message-id": id } = event.headers;
      const { Timestamp: ts } = event.body;
      const meta = {
        id,
        ts,
      };

      try {
        const message = JSON.parse(rawMessage);
        const {
          bucketName: Bucket,
          objectKey: Key,
        } = message.receipt.action;

        const { Body } = await this.getObject({
          Bucket,
          Key,
        });
        const parsed = await simpleParser(Body);
        for (const attachment of parsed.attachments || []) {
          if (!attachment.content) continue;
          attachment.content_b64 = attachment.content.toString("base64");
          delete attachment.content;
        }

        // Emit to the default channel
        this.$emit(parsed, {
          id,
          summary: parsed.subject,
          ts,
        });

        // and a channel specific to the email address
        const address = parsed.to?.[0]?.address;
        if (address) {
          this.$emit(parsed, {
            id,
            name: address,
            summary: parsed.subject,
            ts,
          });
        }
      } catch (err) {
        console.log(
          `Couldn't parse message. Emitting raw message. Error: ${err}`,
        );
        this.$emit({
          rawMessage,
        }, {
          ...meta,
          summary: "Couldn't parse message",
        });
      }
    },
  },
};

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
AWS	`aws`	`app`	This component uses the AWS app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
AWS Region	`region`	`string`	Select a value from the drop down menu.
SES Domain	`domain`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

Action#

Send Document Using Template on BoldSign

Description:Send documents for e-signature using a BoldSign template. [See the documentation](https://developers.boldsign.com/documents/send-document-from-template/?region=us)

Version:0.0.1

Key:boldsign-send-document-template

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import fs from "fs";
import boldsign from "../../boldsign.app.mjs";
import { DOCUMENT_DOWNLOAD_OPTIONS } from "../../common/constants.mjs";
import {
  checkTmp,
  parseObject,
} from "../../common/utils.mjs";

export default {
  key: "boldsign-send-document-template",
  name: "Send Document Using Template",
  description: "Send documents for e-signature using a BoldSign template. [See the documentation](https://developers.boldsign.com/documents/send-document-from-template/?region=us)",
  version: "0.0.1",
  type: "action",
  props: {
    boldsign,
    templateId: {
      propDefinition: [
        boldsign,
        "templateId",
      ],
    },
    title: {
      type: "string",
      label: "Title",
      description: "The title of the document.",
      optional: true,
    },
    message: {
      type: "string",
      label: "Message",
      description: "A message to include with the document.",
      optional: true,
    },
    roles: {
      type: "string[]",
      label: "Roles",
      description: "A role is simply a placeholder for a real person. For example, if we have a purchase order that will always be signed by two people, one from the company and one from the customer, we can create a template with two roles Customer and Representative. Example: **[{\"roleIndex\": 50,\"signerName\": \"Richard\",\"signerOrder\": 1,\"signerEmail\": \"richard@cubeflakes.com\",\"privateMessage\": \"Please check and sign the document.\",\"authenticationCode\": \"281028\",\"enableEmailOTP\": false,\"signerType\": \"Signer\",\"signerRole\": \"Manager\",\"formFields\": [{\"id\": \"SignField\",\"fieldType\": \"Signature\",\"pageNumber\": 1,\"bounds\": {\"x\": 100,\"y\": 100,\"width\": 100,\"height\": 50},\"isRequired\": true}]**.",
    },
    brandId: {
      propDefinition: [
        boldsign,
        "brandId",
      ],
      optional: true,
    },
    labels: {
      propDefinition: [
        boldsign,
        "labels",
      ],
      optional: true,
    },
    disableEmails: {
      type: "boolean",
      label: "Disable Emails",
      description: "Disable sending emails to recipients.",
      optional: true,
    },
    disableSMS: {
      type: "boolean",
      label: "Disable SMS",
      description: "Disable sending SMS to recipients.",
      optional: true,
    },
    hideDocumentId: {
      type: "boolean",
      label: "Hide Document ID",
      description: "Decides whether the document ID should be hidden or not.",
      optional: true,
    },
    enableAutoReminder: {
      type: "boolean",
      label: "Enable Auto Reminder",
      description: "Enable automatic reminders.",
      reloadProps: true,
      optional: true,
    },
    reminderDays: {
      type: "integer",
      label: "Reminder Days",
      description: "Number of days between reminders.",
      hidden: true,
      optional: true,
    },
    reminderCount: {
      type: "integer",
      label: "Reminder Count",
      description: "Number of reminder attempts.",
      hidden: true,
      optional: true,
    },
    cc: {
      propDefinition: [
        boldsign,
        "cc",
      ],
      optional: true,
    },
    expiryDays: {
      type: "integer",
      label: "Expiry Days",
      description: "Number of days before document expires.",
      optional: true,
    },
    enablePrintAndSign: {
      type: "boolean",
      label: "Enable Print and Sign",
      description: "Allow signers to print and sign document.",
      optional: true,
    },
    enableReassign: {
      type: "boolean",
      label: "Enable Reassign",
      description: "Allow signers to reassign the document.",
      optional: true,
    },
    enableSigningOrder: {
      type: "boolean",
      label: "Enable Signing Order",
      description: "Enable signing order for the document.",
      optional: true,
    },
    disableExpiryAlert: {
      type: "boolean",
      label: "Disable Expiry Alert",
      description: "Disable alerts before document expiry.",
      optional: true,
    },
    documentInfo: {
      type: "string[]",
      label: "Document Info",
      description: "Custom information fields for the document. [See the documentation](https://developers.boldsign.com/documents/send-document-from-template) for further information.",
      optional: true,
    },
    roleRemovalIndices: {
      type: "integer[]",
      label: "Role Removal Indices",
      description: "Removes the roles present in the template with their indices given in this property.",
      optional: true,
    },
    documentDownloadOption: {
      type: "string",
      label: "Document Download Option",
      description: "Option for document download configuration.",
      options: DOCUMENT_DOWNLOAD_OPTIONS,
      optional: true,
    },
    formGroups: {
      type: "string[]",
      label: "Form Groups",
      description: "Manages the rules and configuration of grouped form fields. [See the documentation](https://developers.boldsign.com/documents/send-document-from-template) for further information.",
      optional: true,
    },
    files: {
      type: "string[]",
      label: "Files",
      description: "A list of paths to files in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp).",
      optional: true,
    },
    fileUrls: {
      type: "string[]",
      label: "File URLs",
      description: "URLs of files to include in the document.",
      optional: true,
    },
    recipientNotificationSettings: {
      type: "object",
      label: "Recipient Notification Settings",
      description: "Settings for recipient notifications. [See the documentation](https://developers.boldsign.com/documents/send-document-from-template) for further information.",
      optional: true,
    },
    removeFormfields: {
      type: "string[]",
      label: "Remove Formfields",
      description: "The removeFormFields property in API allows you to exclude specific form fields from a document before sending it. You provide a string array with the IDs of the existing form fields you want to remove. One or more values can be specified.",
      optional: true,
    },
    enableAuditTrailLocalization: {
      type: "boolean",
      label: "Enable Audit Trail Localization",
      description: "Enable localization for audit trail based on the signer's language. If null is provided, the value will be inherited from the Business Profile settings. Only one additional language can be specified in the signer's languages besides English.",
      optional: true,
    },
  },
  async additionalProps(props) {
    props.reminderDays.hidden = !this.enableAutoReminder;
    props.reminderCount.hidden = !this.enableAutoReminder;
    return {};
  },
  async run({ $ }) {
    try {
      const files = [];
      if (this.files) {
        for (const file of parseObject(this.files)) {
          const filePath = fs.readFileSync(checkTmp(file), "base64");
          files.push(`data:application/${file.substr(file.length - 3)};base64,${filePath}`);
        }
      }

      const additionalData = {};
      if (this.enableAutoReminder) {
        additionalData.reminderSettings = {
          enableAutoReminder: this.enableAutoReminder,
          reminderDays: this.reminderDays,
          reminderCount: this.reminderCount,
        };
      }

      const response = await this.boldsign.sendDocument({
        $,
        headers: {
          "Content-Type": "application/json;odata.metadata=minimal;odata.streaming=true",
        },
        params: {
          templateId: this.templateId,
        },
        data: {
          title: this.title,
          message: this.message,
          roles: parseObject(this.roles),
          brandId: this.brandId,
          labels: parseObject(this.labels),
          disableEmails: this.disableEmails,
          disableSMS: this.disableSMS,
          hideDocumentId: this.hideDocumentId,
          reminderSettings: {
            enableAutoReminder: this.enableAutoReminder,
            reminderDays: this.reminderDays,
            reminderCount: this.reminderCount,
          },
          cc: parseObject(this.cc)?.map((item) => ({
            emailAddress: item,
          })),
          expiryDays: this.expiryDays,
          enablePrintAndSign: this.enablePrintAndSign,
          enableReassign: this.enableReassign,
          enableSigningOrder: this.enableSigningOrder,
          disableExpiryAlert: this.disableExpiryAlert,
          documentInfo: parseObject(this.documentInfo),
          roleRemovalIndices: parseObject(this.roleRemovalIndices),
          documentDownloadOption: this.documentDownloadOption,
          formGroups: parseObject(this.formGroups),
          files,
          fileUrls: parseObject(this.fileUrls),
          recipientNotificationSettings: parseObject(this.recipientNotificationSettings),
          removeFormfields: parseObject(this.removeFormfields),
          enableAuditTrailLocalization: this.enableAuditTrailLocalization,
          ...additionalData,
        },
      });
      $.export("$summary", `Document sent successfully using template ${this.templateId}`);
      return response;
    } catch ({ message }) {
      const parsedMessage = JSON.parse(message);
      let errorMessage = "";
      if (parsedMessage.error) errorMessage = parsedMessage.error;
      if (parsedMessage.errors) {
        Object.entries(parsedMessage.errors).map(([
          ,
          value,
        ]) => {
          errorMessage += `- ${value[0]}\n`;
        });
      }
      throw new ConfigurationError(errorMessage);
    }
  },
};

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
BoldSign	`boldsign`	`app`	This component uses the BoldSign app.
Template ID	`templateId`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	The title of the document.
Message	`message`	`string`	A message to include with the document.
Roles	`roles`	`string[]`	A role is simply a placeholder for a real person. For example, if we have a purchase order that will always be signed by two people, one from the company and one from the customer, we can create a template with two roles Customer and Representative. Example: [{"roleIndex": 50,"signerName": "Richard","signerOrder": 1,"signerEmail": "richard@cubeflakes.com","privateMessage": "Please check and sign the document.","authenticationCode": "281028","enableEmailOTP": false,"signerType": "Signer","signerRole": "Manager","formFields": [{"id": "SignField","fieldType": "Signature","pageNumber": 1,"bounds": {"x": 100,"y": 100,"width": 100,"height": 50},"isRequired": true}].
Brand ID	`brandId`	`string`	Select a value from the drop down menu.
Labels	`labels`	`string[]`	Labels for categorizing documents.
Disable Emails	`disableEmails`	`boolean`	Disable sending emails to recipients.
Disable SMS	`disableSMS`	`boolean`	Disable sending SMS to recipients.
Hide Document ID	`hideDocumentId`	`boolean`	Decides whether the document ID should be hidden or not.
Enable Auto Reminder	`enableAutoReminder`	`boolean`	Enable automatic reminders.
CC	`cc`	`string[]`	Select a value from the drop down menu.
Expiry Days	`expiryDays`	`integer`	Number of days before document expires.
Enable Print and Sign	`enablePrintAndSign`	`boolean`	Allow signers to print and sign document.
Enable Reassign	`enableReassign`	`boolean`	Allow signers to reassign the document.
Enable Signing Order	`enableSigningOrder`	`boolean`	Enable signing order for the document.
Disable Expiry Alert	`disableExpiryAlert`	`boolean`	Disable alerts before document expiry.
Document Info	`documentInfo`	`string[]`	Custom information fields for the document. See the documentation for further information.
Role Removal Indices	`roleRemovalIndices`	`integer[]`	Removes the roles present in the template with their indices given in this property.
Document Download Option	`documentDownloadOption`	`string`	Select a value from the drop down menu:`CombinedIndividually`
Form Groups	`formGroups`	`string[]`	Manages the rules and configuration of grouped form fields. See the documentation for further information.
Files	`files`	`string[]`	A list of paths to files in the `/tmp` directory. See the documentation on working with files.
File URLs	`fileUrls`	`string[]`	URLs of files to include in the document.
Recipient Notification Settings	`recipientNotificationSettings`	`object`	Settings for recipient notifications. See the documentation for further information.
Remove Formfields	`removeFormfields`	`string[]`	The removeFormFields property in API allows you to exclude specific form fields from a document before sending it. You provide a string array with the IDs of the existing form fields you want to remove. One or more values can be specified.
Enable Audit Trail Localization	`enableAuditTrailLocalization`	`boolean`	Enable localization for audit trail based on the signer's language. If null is provided, the value will be inherited from the Business Profile settings. Only one additional language can be specified in the signer's languages besides English.

Action Authentication#

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

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

offline_accessBoldSign.Users.ReadBoldSign.Documents.WriteBoldSign.Documents.CreateBoldSign.Templates.ReadBoldSign.Templates.WriteBoldSign.Templates.CreateBoldSign.SenderIdentity.ReadBoldSign.Documents.ReadBoldSign.Contacts.Read

About BoldSign#

Electronic Signature Software & API

More Ways to Connect BoldSign + AWS#

Other Popular Integrations#

Send Document Using Template with BoldSign API on New DynamoDB Stream Event from AWS API

AWS + BoldSign

Send Document Using Template with BoldSign API on New Inbound SES Emails from AWS API

Pipedream makes it easy to connect APIs for BoldSign, AWS and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular