Mail Letter with DocuPost API on New Record (Instant, of Selectable Type) from Salesforce API

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

Trigger workflow on

New Record (Instant, of Selectable Type) from the Salesforce API

Next, do this

Mail Letter with the DocuPost 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 Salesforce trigger and DocuPost action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Record (Instant, of Selectable Type) trigger
1. Connect your Salesforce account
2. Configure timer
3. Select a Object Type
4. Optional- Select one or more Fields to Obtain
Configure the Mail Letter action
1. Connect your DocuPost account
2. Configure PDF URL
3. Optional- Configure Color
4. Optional- Configure Double-Sided
5. Optional- Select a Class
6. Optional- Select a Service Level
7. Configure Recipient's Name
8. Configure Recipient's Address Line 1
9. Optional- Configure Recipient's Address Line 2
10. Configure Recipient's City
11. Select a Recipient's State
12. Configure Recipient's Postal Code
13. Configure Sender's Name
14. Configure Sender's Address Line 1
15. Optional- Configure Sender's Address Line 2
16. Configure Sender's City
17. Select a Sender's State
18. Configure Sender's Postal Code
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 Record (Instant, of Selectable Type) on Salesforce

Description:Emit new event when a record of the selected object type is created. [See the documentation](https://sforce.co/3yPSJZy)

Version:0.2.0

Key:salesforce_rest_api-new-record-instant

View on GitHub

Salesforce Overview#

The Salesforce (REST API) provides a powerful platform for creating and managing customer relationships with a wide array of features like data manipulation, querying, and complex automation. With Pipedream's serverless execution, you can create workflows that automate your sales processes, sync data with other platforms, enhance customer engagement, and trigger actions based on specific events. Dive into Salesforce data, streamline lead management, track customer interactions, and push or pull data to or from Salesforce seamlessly.

Trigger Code#

import startCase from "lodash/startCase.js";
import common from "../common.mjs";

export default {
  ...common,
  type: "source",
  name: "New Record (Instant, of Selectable Type)",
  key: "salesforce_rest_api-new-record-instant",
  description: "Emit new event when a record of the selected object type is created. [See the documentation](https://sforce.co/3yPSJZy)",
  version: "0.2.0",
  props: {
    ...common.props,
    fieldsToObtain: {
      propDefinition: [
        common.props.salesforce,
        "fieldsToObtain",
        (c) => ({
          objType: c.objectType,
        }),
      ],
      optional: true,
      description: "Select the field(s) to be retrieved for the records. Only applicable if the source is running on a timer. If running on a webhook, or if not specified, all fields will be retrieved.",
    },
  },
  hooks: {
    ...common.hooks,
    async deploy() {
      const objectType = this.objectType;
      const nameField = await this.salesforce.getNameFieldForObjectType(objectType);
      this.setNameField(nameField);

      // emit historical events
      const { recentItems } = await this.salesforce.listSObjectTypeIds(objectType);
      const ids = recentItems.map((item) => item.Id);
      for (const id of ids.slice(-25)) {
        const object = await this.salesforce.getSObject(objectType, id);
        const event = {
          body: {
            "New": object,
            "UserId": id,
          },
        };
        this.processWebhookEvent(event);
      }
    },
  },
  methods: {
    ...common.methods,
    generateTimerMeta(item, fieldName) {
      const { objectType } = this;
      const {
        CreatedDate: createdDate,
        [fieldName]: name,
        Id: id,
      } = item;
      const entityType = startCase(objectType);
      const summary = `New ${entityType} created: ${name ?? id}`;
      const ts = Date.parse(createdDate);
      return {
        id,
        summary,
        ts,
      };
    },
    generateWebhookMeta(data) {
      const nameField = this.getNameField();
      const { New: newObject } = data.body;
      const {
        CreatedDate: createdDate,
        Id: id,
        [nameField]: name,
      } = newObject;
      const entityType = startCase(this.objectType).toLowerCase();
      const summary = `New ${entityType} created: ${name ?? id}`;
      const ts = Date.parse(createdDate);
      return {
        id,
        summary,
        ts,
      };
    },
    getEventType() {
      return "new";
    },
    async processTimerEvent(eventData) {
      const {
        paginate,
        objectType,
        setLatestDateCovered,
        getObjectTypeColumns,
        getNameField,
        generateTimerMeta,
        $emit: emit,
      } = this;

      const {
        startTimestamp,
        endTimestamp,
      } = eventData;

      const fieldName = getNameField();
      const columns = getObjectTypeColumns();

      const events = await paginate({
        objectType,
        startTimestamp,
        endTimestamp,
        columns,
      });

      const [
        latestEvent,
      ] = events;

      if (latestEvent?.CreatedDate) {
        const latestDateCovered = new Date(latestEvent.CreatedDate);
        latestDateCovered.setSeconds(0);
        setLatestDateCovered(latestDateCovered.toISOString());
      }

      Array.from(events)
        .reverse()
        .forEach((item) => {
          const meta = generateTimerMeta(item, fieldName);
          emit(item, meta);
        });
    },
    async timerActivateHook() {
      const {
        objectType,
        getObjectTypeDescription,
        setObjectTypeColumns,
      } = this;

      let columns = this.fieldsToObtain;
      if (!columns?.length) {
        const { fields } = await getObjectTypeDescription(objectType);
        columns = fields.map(({ name }) => name);
      }

      setObjectTypeColumns(columns);
    },
  },
};

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
Salesforce	`salesforce`	`app`	This component uses the Salesforce 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.
	`timer`	`$.interface.timer`	The timer is only used as a fallback if instant event delivery (webhook) is not available.
Object Type	`objectType`	`string`	Select a value from the drop down menu.
Fields to Obtain	`fieldsToObtain`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

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

About Salesforce#

Web services API for interacting with Salesforce

Action#

Mail Letter on DocuPost

Description:Sends a physical letter via USPS first class mail. [See the documentation](https://help.docupost.com/help/send-letter-api)

Version:0.0.1

Key:docupost-mail-letter

View on GitHub

DocuPost Overview#

The DocuPost API enables automated mail handling, offering services like sending letters, postcards, and checks via a programmatic interface. Within Pipedream, you can harness this API to create dynamic, serverless workflows that trigger postal mail actions based on various events from a plethora of supported apps. Think of automating thank-you notes, payment disbursements, or direct mail marketing campaigns, all reacting in real-time to user behavior, payment events, or custom triggers.

Action Code#

import app from "../../docupost.app.mjs";

export default {
  key: "docupost-mail-letter",
  name: "Mail Letter",
  description: "Sends a physical letter via USPS first class mail. [See the documentation](https://help.docupost.com/help/send-letter-api)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    pdf: {
      type: "string",
      label: "PDF URL",
      description: "A valid PDF URL for the letter content. `10mb` max. 8.5x11 recommended.",
    },
    color: {
      type: "boolean",
      label: "Color",
      description: "Whether the document should be in color. `true` or `false`. Defaults to `false`.",
      optional: true,
    },
    doublesided: {
      type: "string",
      label: "Double-Sided",
      description: "Whether the document should be printed double-sided. `true` or `false`. Defaults to `true`.",
      optional: true,
    },
    mailingClass: {
      type: "string",
      label: "Class",
      description: "Must be `usps_first_class` or `usps_standard`. Defaults to `usps_first_class`.",
      options: [
        "usps_first_class",
        "usps_standard",
      ],
      optional: true,
    },
    servicelevel: {
      type: "string",
      label: "Service Level",
      description: "Only available for `usps_first_class` mailings. Should be blank for non-certified, or `certified` or `certified_return_receipt`.",
      options: [
        {
          value: "",
          label: "Non-Certified",
        },
        {
          value: "certified",
          label: "Certified",
        },
        {
          value: "certified_return_receipt",
          label: "Certified Return Receipt",
        },
      ],
      optional: true,
    },
    toName: {
      propDefinition: [
        app,
        "toName",
      ],
    },
    toAddress1: {
      propDefinition: [
        app,
        "toAddress1",
      ],
    },
    toAddress2: {
      propDefinition: [
        app,
        "toAddress2",
      ],
    },
    toCity: {
      propDefinition: [
        app,
        "toCity",
      ],
    },
    toState: {
      propDefinition: [
        app,
        "toState",
      ],
    },
    toZip: {
      propDefinition: [
        app,
        "toZip",
      ],
    },
    fromName: {
      propDefinition: [
        app,
        "fromName",
      ],
    },
    fromAddress1: {
      propDefinition: [
        app,
        "fromAddress1",
      ],
    },
    fromAddress2: {
      propDefinition: [
        app,
        "fromAddress2",
      ],
    },
    fromCity: {
      propDefinition: [
        app,
        "fromCity",
      ],
    },
    fromState: {
      propDefinition: [
        app,
        "fromState",
      ],
    },
    fromZip: {
      propDefinition: [
        app,
        "fromZip",
      ],
    },
  },
  methods: {
    sendLetter(args = {}) {
      return this.app.post({
        path: "/sendletter",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      sendLetter,
      pdf,
      color,
      doublesided,
      mailingClass,
      servicelevel,
      toName,
      toAddress1,
      toAddress2,
      toCity,
      toState,
      toZip,
      fromName,
      fromAddress1,
      fromAddress2,
      fromCity,
      fromState,
      fromZip,
    } = this;

    const response = await sendLetter({
      $,
      params: {
        pdf,
        color,
        doublesided,
        class: mailingClass,
        servicelevel,
        to_name: toName,
        to_address1: toAddress1,
        to_address2: toAddress2,
        to_city: toCity,
        to_state: toState,
        to_zip: toZip,
        from_name: fromName,
        from_address1: fromAddress1,
        from_address2: fromAddress2,
        from_city: fromCity,
        from_state: fromState,
        from_zip: fromZip,
      },
    });

    $.export("$summary", "Successfully sent letter");
    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
DocuPost	`app`	`app`	This component uses the DocuPost app.
PDF URL	`pdf`	`string`	A valid PDF URL for the letter content. `10mb` max. 8.5x11 recommended.
Color	`color`	`boolean`	Whether the document should be in color. `true` or `false`. Defaults to `false`.
Double-Sided	`doublesided`	`string`	Whether the document should be printed double-sided. `true` or `false`. Defaults to `true`.
Class	`mailingClass`	`string`	Select a value from the drop down menu:`usps_first_classusps_standard`
Service Level	`servicelevel`	`string`	Select a value from the drop down menu:`{ "value": "", "label": "Non-Certified" }{ "value": "certified", "label": "Certified" }{ "value": "certified_return_receipt", "label": "Certified Return Receipt" }`
Recipient's Name	`toName`	`string`	The name of the recipient (who the letter/postcard is being sent to). Must be less than 40 characters.
Recipient's Address Line 1	`toAddress1`	`string`	The first line of the recipient's address.
Recipient's Address Line 2	`toAddress2`	`string`	The second line of the recipient's address.
Recipient's City	`toCity`	`string`	The city of the recipient.
Recipient's State	`toState`	`string`	Select a value from the drop down menu:`{ "label": "Alabama", "value": "AL" }{ "label": "Alaska", "value": "AK" }{ "label": "American Samoa", "value": "AS" }{ "label": "Arizona", "value": "AZ" }{ "label": "Arkansas", "value": "AR" }{ "label": "California", "value": "CA" }{ "label": "Colorado", "value": "CO" }{ "label": "Connecticut", "value": "CT" }{ "label": "Delaware", "value": "DE" }{ "label": "District of Columbia", "value": "DC" }{ "label": "Federated States of Micronesia", "value": "FM" }{ "label": "Florida", "value": "FL" }{ "label": "Georgia", "value": "GA" }{ "label": "Guam", "value": "GU" }{ "label": "Hawaii", "value": "HI" }{ "label": "Idaho", "value": "ID" }{ "label": "Illinois", "value": "IL" }{ "label": "Indiana", "value": "IN" }{ "label": "Iowa", "value": "IA" }{ "label": "Kansas", "value": "KS" }{ "label": "Kentucky", "value": "KY" }{ "label": "Louisiana", "value": "LA" }{ "label": "Maine", "value": "ME" }{ "label": "Marshall Islands", "value": "MH" }{ "label": "Maryland", "value": "MD" }{ "label": "Massachusetts", "value": "MA" }{ "label": "Michigan", "value": "MI" }{ "label": "Minnesota", "value": "MN" }{ "label": "Mississippi", "value": "MS" }{ "label": "Missouri", "value": "MO" }{ "label": "Montana", "value": "MT" }{ "label": "Nebraska", "value": "NE" }{ "label": "Nevada", "value": "NV" }{ "label": "New Hampshire", "value": "NH" }{ "label": "New Jersey", "value": "NJ" }{ "label": "New Mexico", "value": "NM" }{ "label": "New York", "value": "NY" }{ "label": "North Carolina", "value": "NC" }{ "label": "North Dakota", "value": "ND" }{ "label": "Northern Mariana Islands", "value": "MP" }{ "label": "Ohio", "value": "OH" }{ "label": "Oklahoma", "value": "OK" }{ "label": "Oregon", "value": "OR" }{ "label": "Palau", "value": "PW" }{ "label": "Pennsylvania", "value": "PA" }{ "label": "Puerto Rico", "value": "PR" }{ "label": "Rhode Island", "value": "RI" }{ "label": "South Carolina", "value": "SC" }{ "label": "South Dakota", "value": "SD" }{ "label": "Tennessee", "value": "TN" }{ "label": "Texas", "value": "TX" }{ "label": "Utah", "value": "UT" }{ "label": "Vermont", "value": "VT" }{ "label": "Virgin Islands", "value": "VI" }{ "label": "Virginia", "value": "VA" }{ "label": "Washington", "value": "WA" }{ "label": "West Virginia", "value": "WV" }{ "label": "Wisconsin", "value": "WI" }{ "label": "Wyoming", "value": "WY" }{ "label": "Armed Forces Europe, the Middle East, and Canada", "value": "AE" }{ "label": "Armed Forces Pacific", "value": "AP" }{ "label": "Armed Forces Americas (except Canada)", "value": "AA" }{ "label": "North", "value": "N" }{ "label": "East", "value": "E" }{ "label": "South", "value": "S" }{ "label": "West", "value": "W" }{ "label": "Northeast", "value": "NE" }{ "label": "Southeast", "value": "SE" }{ "label": "Northwest", "value": "NW" }{ "label": "Southwest", "value": "SW" }`
Recipient's Postal Code	`toZip`	`string`	The 5-digit postal code for the recipient.
Sender's Name	`fromName`	`string`	Your sender/return address name. Must be less than 40 characters.
Sender's Address Line 1	`fromAddress1`	`string`	The first line of your sender/return address.
Sender's Address Line 2	`fromAddress2`	`string`	The second line of your sender/return address.
Sender's City	`fromCity`	`string`	The city of your sender/return address.
Sender's State	`fromState`	`string`	Select a value from the drop down menu:`{ "label": "Alabama", "value": "AL" }{ "label": "Alaska", "value": "AK" }{ "label": "American Samoa", "value": "AS" }{ "label": "Arizona", "value": "AZ" }{ "label": "Arkansas", "value": "AR" }{ "label": "California", "value": "CA" }{ "label": "Colorado", "value": "CO" }{ "label": "Connecticut", "value": "CT" }{ "label": "Delaware", "value": "DE" }{ "label": "District of Columbia", "value": "DC" }{ "label": "Federated States of Micronesia", "value": "FM" }{ "label": "Florida", "value": "FL" }{ "label": "Georgia", "value": "GA" }{ "label": "Guam", "value": "GU" }{ "label": "Hawaii", "value": "HI" }{ "label": "Idaho", "value": "ID" }{ "label": "Illinois", "value": "IL" }{ "label": "Indiana", "value": "IN" }{ "label": "Iowa", "value": "IA" }{ "label": "Kansas", "value": "KS" }{ "label": "Kentucky", "value": "KY" }{ "label": "Louisiana", "value": "LA" }{ "label": "Maine", "value": "ME" }{ "label": "Marshall Islands", "value": "MH" }{ "label": "Maryland", "value": "MD" }{ "label": "Massachusetts", "value": "MA" }{ "label": "Michigan", "value": "MI" }{ "label": "Minnesota", "value": "MN" }{ "label": "Mississippi", "value": "MS" }{ "label": "Missouri", "value": "MO" }{ "label": "Montana", "value": "MT" }{ "label": "Nebraska", "value": "NE" }{ "label": "Nevada", "value": "NV" }{ "label": "New Hampshire", "value": "NH" }{ "label": "New Jersey", "value": "NJ" }{ "label": "New Mexico", "value": "NM" }{ "label": "New York", "value": "NY" }{ "label": "North Carolina", "value": "NC" }{ "label": "North Dakota", "value": "ND" }{ "label": "Northern Mariana Islands", "value": "MP" }{ "label": "Ohio", "value": "OH" }{ "label": "Oklahoma", "value": "OK" }{ "label": "Oregon", "value": "OR" }{ "label": "Palau", "value": "PW" }{ "label": "Pennsylvania", "value": "PA" }{ "label": "Puerto Rico", "value": "PR" }{ "label": "Rhode Island", "value": "RI" }{ "label": "South Carolina", "value": "SC" }{ "label": "South Dakota", "value": "SD" }{ "label": "Tennessee", "value": "TN" }{ "label": "Texas", "value": "TX" }{ "label": "Utah", "value": "UT" }{ "label": "Vermont", "value": "VT" }{ "label": "Virgin Islands", "value": "VI" }{ "label": "Virginia", "value": "VA" }{ "label": "Washington", "value": "WA" }{ "label": "West Virginia", "value": "WV" }{ "label": "Wisconsin", "value": "WI" }{ "label": "Wyoming", "value": "WY" }{ "label": "Armed Forces Europe, the Middle East, and Canada", "value": "AE" }{ "label": "Armed Forces Pacific", "value": "AP" }{ "label": "Armed Forces Americas (except Canada)", "value": "AA" }{ "label": "North", "value": "N" }{ "label": "East", "value": "E" }{ "label": "South", "value": "S" }{ "label": "West", "value": "W" }{ "label": "Northeast", "value": "NE" }{ "label": "Southeast", "value": "SE" }{ "label": "Northwest", "value": "NW" }{ "label": "Southwest", "value": "SW" }`
Sender's Postal Code	`fromZip`	`string`	The 5-digit postal code for your sender/return address.

Action Authentication#

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