Send Fax with Phaxio API on New Record (Instant, of Selectable Type) from Salesforce API

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

Trigger workflow on

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

Next, do this

Send Fax with the Phaxio 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 Phaxio 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 Send Fax action
1. Connect your Phaxio account
2. Configure To
3. Configure Content URL
4. Optional- Configure Header Text
5. Optional- Configure Header Page Nums
6. Optional- Configure Callback URL
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#

Send Fax on Phaxio

Description:Sends a fax. [See docs here](https://www.phaxio.com/docs/api/v2.1/faxes/create_and_send_fax)

Version:0.0.1

Key:phaxio-send-fax

View on GitHub

Phaxio Overview#

The Phaxio API turns the cumbersome fax communication into a streamlined digital process. By leveraging Phaxio with Pipedream, you can automate sending and receiving faxes, manage fax statuses, and integrate fax capabilities into your existing digital workflows without dealing with traditional fax machines. This can be particularly useful for industries like healthcare, legal, or finance where faxing documents is still prevalent.

Action Code#

import phaxio from "../../phaxio.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  name: "Send Fax",
  version: "0.0.1",
  key: "phaxio-send-fax",
  description: "Sends a fax. [See docs here](https://www.phaxio.com/docs/api/v2.1/faxes/create_and_send_fax)",
  type: "action",
  props: {
    phaxio,
    to: {
      label: "To",
      description: "A phone number in [E.164 format](https://www.twilio.com/docs/glossary/what-e164) (+[country code][number]). E.g. `+5547991856893`",
      type: "string",
    },
    contentUrl: {
      label: "Content URL",
      description: "A URL to be rendered and sent as the fax content. E.g. `https://i.imgur.com/BRkm0s0.jpeg`",
      type: "string",
    },
    headerText: {
      label: "Header Text",
      description: "Text that will be displayed at the top of each page of the fax. 50 characters maximum, all unicode characters accepted.",
      type: "string",
      optional: true,
    },
    headerPageNums: {
      label: "Header Page Nums",
      description: "Turns page numbers in header on or off. Default is `true`",
      type: "boolean",
      default: true,
      optional: true,
    },
    callbackUrl: {
      label: "Callback URL",
      description: "You can specify a callback url that will override the one you have defined globally for your account.",
      type: "string",
      optional: true,
    },
  },
  async run({ $ }) {
    if (this.headerText?.length > 50) {
      throw new ConfigurationError("The header must be have an maximum of 50 characters");
    }

    const response = await this.phaxio.sendFax({
      $,
      data: {
        to: this.to,
        content_url: this.contentUrl,
        header_text: this.headerText,
        header_page_nums: this.headerPageNums,
        callback_url: this.callbackUrl,
      },
    });

    if (response) {
      $.export("$summary", `Successfully sent fax with id ${response.id}`);
    }

    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
Phaxio	`phaxio`	`app`	This component uses the Phaxio app.
To	`to`	`string`	A phone number in E.164 format (+[country code][number]). E.g. `+5547991856893`
Content URL	`contentUrl`	`string`	A URL to be rendered and sent as the fax content. E.g. `https://i.imgur.com/BRkm0s0.jpeg`
Header Text	`headerText`	`string`	Text that will be displayed at the top of each page of the fax. 50 characters maximum, all unicode characters accepted.
Header Page Nums	`headerPageNums`	`boolean`	Turns page numbers in header on or off. Default is `true`
Callback URL	`callbackUrl`	`string`	You can specify a callback url that will override the one you have defined globally for your account.

Action Authentication#

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

To get your API key and secret, go to the API Keys page in Phaxio's sidebar.