Mail PDF Document with OnlineCheckWriter API on New Record (Instant, of Selectable Type) from Salesforce API

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

Trigger workflow on

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

Next, do this

Mail PDF Document with the OnlineCheckWriter 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 OnlineCheckWriter 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 PDF Document action
1. Connect your OnlineCheckWriter account
2. Optional- Configure Document Title
3. Configure File Path or URL
4. Select a Shipping Type ID
5. Optional- Configure Sender Name
6. Optional- Configure Sender Company
7. Optional- Configure Sender Address 1
8. Optional- Configure Sender Address 2
9. Optional- Configure Sender City
10. Optional- Configure Sender State
11. Optional- Configure Sender Zip
12. Optional- Configure Sender Phone
13. Optional- Configure Sender Email
14. Configure Destination Name
15. Optional- Configure Destination Company
16. Configure Destination Address 1
17. Optional- Configure Destination Address 2
18. Configure Destination City
19. Configure Destination State
20. Configure Destination Zip
21. Optional- Configure Destination Phone
22. Optional- Configure Destination Email
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#

Cloud-based customer relationship management (CRM) platform that helps businesses manage sales, marketing, customer support, and other business activities, ultimately aiming to improve customer relationships and streamline operations.

Action#

Mail PDF Document on OnlineCheckWriter

Description:Mails a PDF document to a destination. [See the documentation](https://apiv3.onlinecheckwriter.com/#878daf05-e36e-44a2-bce8-15f24d72f82e).

Version:0.1.0

Key:onlinecheckwriter-mail-pdf-document

View on GitHub

Action Code#

import FormData from "form-data";
import { getFileStreamAndMetadata } from "@pipedream/platform";
import app from "../../onlinecheckwriter.app.mjs";

export default {
  key: "onlinecheckwriter-mail-pdf-document",
  name: "Mail PDF Document",
  description: "Mails a PDF document to a destination. [See the documentation](https://apiv3.onlinecheckwriter.com/#878daf05-e36e-44a2-bce8-15f24d72f82e).",
  version: "0.1.0",
  type: "action",
  props: {
    app,
    documentTitle: {
      type: "string",
      label: "Document Title",
      description: "The title of the document.",
      optional: true,
    },
    filePath: {
      type: "string",
      label: "File Path or URL",
      description: "The PDF file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`)",
    },
    shippingTypeId: {
      optional: false,
      propDefinition: [
        app,
        "shippingTypeId",
      ],
    },
    senderName: {
      type: "string",
      label: "Sender Name",
      description: "The name of the sender.",
      optional: true,
    },
    senderCompany: {
      type: "string",
      label: "Sender Company",
      description: "The company of the sender.",
      optional: true,
    },
    senderAddress1: {
      type: "string",
      label: "Sender Address 1",
      description: "The first line of the sender's address.",
      optional: true,
    },
    senderAddress2: {
      type: "string",
      label: "Sender Address 2",
      description: "The second line of the sender's address.",
      optional: true,
    },
    senderCity: {
      type: "string",
      label: "Sender City",
      description: "The city of the sender.",
      optional: true,
    },
    senderState: {
      type: "string",
      label: "Sender State",
      description: "The state of the sender.",
      optional: true,
    },
    senderZip: {
      type: "string",
      label: "Sender Zip",
      description: "The zip code of the sender.",
      optional: true,
    },
    senderPhone: {
      type: "string",
      label: "Sender Phone",
      description: "The phone number of the sender.",
      optional: true,
    },
    senderEmail: {
      type: "string",
      label: "Sender Email",
      description: "The email address of the sender.",
      optional: true,
    },
    destinationName: {
      type: "string",
      label: "Destination Name",
      description: "The name of the recipient.",
    },
    destinationCompany: {
      type: "string",
      label: "Destination Company",
      description: "The company of the recipient.",
      optional: true,
    },
    destinationAddress1: {
      type: "string",
      label: "Destination Address 1",
      description: "The first line of the recipient's address.",
    },
    destinationAddress2: {
      type: "string",
      label: "Destination Address 2",
      description: "The second line of the recipient's address.",
      optional: true,
    },
    destinationCity: {
      type: "string",
      label: "Destination City",
      description: "The city of the recipient.",
    },
    destinationState: {
      type: "string",
      label: "Destination State",
      description: "The state of the recipient. Use 2 characters Eg. `Tx` instead of `Texas` for example.",
    },
    destinationZip: {
      type: "string",
      label: "Destination Zip",
      description: "The zip code of the recipient.",
    },
    destinationPhone: {
      type: "string",
      label: "Destination Phone",
      description: "The phone number of the recipient.",
      optional: true,
    },
    destinationEmail: {
      type: "string",
      label: "Destination Email",
      description: "The email address of the recipient.",
      optional: true,
    },
  },
  methods: {
    mailPdfDocument(args = {}) {
      return this.app.post({
        path: "/documentmailing/mail",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      mailPdfDocument,
      documentTitle,
      filePath,
      shippingTypeId,
      senderName,
      senderCompany,
      senderAddress1,
      senderAddress2,
      senderCity,
      senderState,
      senderZip,
      senderPhone,
      senderEmail,
      destinationName,
      destinationCompany,
      destinationAddress1,
      destinationAddress2,
      destinationCity,
      destinationState,
      destinationZip,
      destinationPhone,
      destinationEmail,
    } = this;

    const data = new FormData();
    const {
      stream, metadata,
    } = await getFileStreamAndMetadata(filePath);
    data.append("document_details[file]", stream, {
      contentType: metadata.contentType,
      knownLength: metadata.size,
      filename: metadata.name,
    });
    data.append("document_details[title]", documentTitle || "");
    data.append("shipping[shippingTypeId]", shippingTypeId || "");
    data.append("destination[name]", destinationName || "");
    data.append("destination[company]", destinationCompany || "");
    data.append("destination[address1]", destinationAddress1 || "");
    data.append("destination[address2]", destinationAddress2 || "");
    data.append("destination[city]", destinationCity || "");
    data.append("destination[state]", destinationState || "");
    data.append("destination[zip]", destinationZip || "");
    data.append("destination[phone]", destinationPhone || "");
    data.append("destination[email]", destinationEmail || "");
    data.append("from_address[name]", senderName || "");
    data.append("from_address[company]", senderCompany || "");
    data.append("from_address[address1]", senderAddress1 || "");
    data.append("from_address[address2]", senderAddress2 || "");
    data.append("from_address[city]", senderCity || "");
    data.append("from_address[state]", senderState || "");
    data.append("from_address[zip]", senderZip || "");
    data.append("from_address[phone]", senderPhone || "");
    data.append("from_address[email]", senderEmail || "");
    const response = await mailPdfDocument({
      $,
      data,
      headers: data.getHeaders(),
    });

    $.export("$summary", "Successfully generated and mailed PDF document");
    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
OnlineCheckWriter	`app`	`app`	This component uses the OnlineCheckWriter app.
Document Title	`documentTitle`	`string`	The title of the document.
File Path or URL	`filePath`	`string`	The PDF file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`)
Shipping Type ID	`shippingTypeId`	`string`	Select a value from the drop down menu:`{ "label": "First Class", "value": "1" }{ "label": "First Class with Tracking", "value": "3" }{ "label": "Priority Mail", "value": "4" }{ "label": "Express Mail", "value": "5" }{ "label": "Standard Overnight -Fedex-By 3pm the next business day", "value": "12" }{ "label": "Fedex Saturday Delivery", "value": "20" }`
Sender Name	`senderName`	`string`	The name of the sender.
Sender Company	`senderCompany`	`string`	The company of the sender.
Sender Address 1	`senderAddress1`	`string`	The first line of the sender's address.
Sender Address 2	`senderAddress2`	`string`	The second line of the sender's address.
Sender City	`senderCity`	`string`	The city of the sender.
Sender State	`senderState`	`string`	The state of the sender.
Sender Zip	`senderZip`	`string`	The zip code of the sender.
Sender Phone	`senderPhone`	`string`	The phone number of the sender.
Sender Email	`senderEmail`	`string`	The email address of the sender.
Destination Name	`destinationName`	`string`	The name of the recipient.
Destination Company	`destinationCompany`	`string`	The company of the recipient.
Destination Address 1	`destinationAddress1`	`string`	The first line of the recipient's address.
Destination Address 2	`destinationAddress2`	`string`	The second line of the recipient's address.
Destination City	`destinationCity`	`string`	The city of the recipient.
Destination State	`destinationState`	`string`	The state of the recipient. Use 2 characters Eg. `Tx` instead of `Texas` for example.
Destination Zip	`destinationZip`	`string`	The zip code of the recipient.
Destination Phone	`destinationPhone`	`string`	The phone number of the recipient.
Destination Email	`destinationEmail`	`string`	The email address of the recipient.

Action Authentication#

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