Send SMS with BulkGate API on New Updated Record (Instant, of Selectable Type) from Salesforce API

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

Trigger workflow on

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

Next, do this

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

Select this integration
Configure the New Updated 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 Watch
Configure the Send SMS action
1. Connect your BulkGate account
2. Configure Recipient Number
3. Configure Message Text
4. Optional- Configure Is Unicode
5. Optional- Select a Sender ID
6. Optional- Configure Sender ID Value
7. Optional- Configure Country
8. Optional- Configure Application ID
9. Optional- Configure Application Token
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 Updated Record (Instant, of Selectable Type) on Salesforce

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

Version:0.2.0

Key:salesforce_rest_api-record-updated-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";
import constants from "../../common/constants.mjs";
const { salesforce } = common.props;

export default {
  ...common,
  type: "source",
  name: "New Updated Record (Instant, of Selectable Type)",
  key: "salesforce_rest_api-record-updated-instant",
  description: "Emit new event when a record of the selected type is updated. [See the documentation](https://sforce.co/3yPSJZy)",
  version: "0.2.0",
  props: {
    ...common.props,
    fields: {
      propDefinition: [
        salesforce,
        "field",
        ({ objectType }) => ({
          objectType,
          filter: ({ updateable }) => updateable,
        }),
      ],
      label: "Fields To Watch",
      type: "string[]",
      optional: true,
      description: "If specified, events will only be emitted if at least one of the selected fields is updated. This filter is only available when a webhook is created successfully.",
    },
  },
  methods: {
    ...common.methods,
    generateWebhookMeta(data) {
      const nameField = this.getNameField();
      const { New: newObject } = data.body;
      const {
        LastModifiedDate: lastModifiedDate,
        Id: id,
        [nameField]: name,
      } = newObject;
      const entityType = startCase(this.objectType);
      const summary = `${entityType} updated: ${name}`;
      const ts = Date.parse(lastModifiedDate);
      const compositeId = `${id}-${ts}`;
      return {
        id: compositeId,
        summary,
        ts,
      };
    },
    generateTimerMeta(item, fieldName) {
      const { objectType } = this;

      const {
        LastModifiedDate: lastModifiedDate,
        [fieldName]: name,
        Id: id,
      } = item;

      const entityType = startCase(objectType);
      const summary = `${entityType} updated: ${name}`;
      const ts = Date.parse(lastModifiedDate);
      return {
        id: `${id}-${ts}`,
        summary,
        ts,
      };
    },
    getEventType() {
      return "updated";
    },
    isEventRelevant(changedFields) {
      const { fields } = this;
      return fields?.length
        ? Object.keys(changedFields).some((key) => fields.includes(key))
        : true;
    },
    getChangedFields(body) {
      return Object.entries(body.New).filter(([
        key,
        value,
      ]) => {
        const oldValue = body.Old[key];
        return (
          value !== undefined
          && oldValue !== undefined
          && JSON.stringify(value) !== JSON.stringify(oldValue)
        );
      })
        .reduce((obj, [
          key,
          value,
        ]) => {
          obj[key] = {
            old: body.Old[key],
            new: value,
          };
          return obj;
        }, {});
    },
    processWebhookEvent(event) {
      const { body } = event;
      const changedFields = this.getChangedFields(body);
      if (this.isEventRelevant(changedFields)) {
        const meta = this.generateWebhookMeta(event);
        this.$emit({
          ...body,
          changedFields,
        }, meta);
      }
    },
    async processTimerEvent(eventData) {
      const {
        getNameField,
        getObjectTypeColumns,
        paginate,
        objectType,
        setLatestDateCovered,
        generateTimerMeta,
        $emit: emit,
      } = this;

      const {
        startTimestamp,
        endTimestamp,
      } = eventData;

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

      const events = await paginate({
        objectType,
        startTimestamp,
        endTimestamp,
        columns,
        dateFieldName: constants.FIELD_NAME.LAST_MODIFIED_DATE,
      });

      const [
        latestEvent,
      ] = events;

      if (latestEvent?.LastModifiedDate) {
        const latestDateCovered = new Date(latestEvent.LastModifiedDate);
        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;

      const { fields } = await getObjectTypeDescription(objectType);
      const 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 Watch	`fields`	`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 SMS on BulkGate

Description:Sends an SMS message to a phone number. [See the docs](https://help.bulkgate.com/docs/en/http-simple-transactional-post-json.html).

Version:0.0.1

Key:bulkgate-send-sms

View on GitHub

BulkGate Overview#

The BulkGate API enables automated sending of SMS messages, offering a powerful way to communicate with customers or users directly through their mobile devices. With this API on Pipedream, you can craft workflows that trigger SMS notifications based on specific events, such as new sign-ups, transaction alerts, or appointment reminders. It's a tool for enhancing customer engagement, support, and conversion through timely and personalized messaging.

Action Code#

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

export default {
  key: "bulkgate-send-sms",
  name: "Send SMS",
  description: "Sends an SMS message to a phone number. [See the docs](https://help.bulkgate.com/docs/en/http-simple-transactional-post-json.html).",
  type: "action",
  version: "0.0.1",
  props: {
    app,
    number: {
      propDefinition: [
        app,
        "number",
      ],
    },
    text: {
      propDefinition: [
        app,
        "text",
      ],
    },
    unicode: {
      propDefinition: [
        app,
        "unicode",
      ],
    },
    senderId: {
      propDefinition: [
        app,
        "senderId",
      ],
    },
    senderIdValue: {
      propDefinition: [
        app,
        "senderIdValue",
      ],
    },
    country: {
      propDefinition: [
        app,
        "country",
      ],
    },
    appId: {
      propDefinition: [
        app,
        "appId",
      ],
    },
    appToken: {
      propDefinition: [
        app,
        "appToken",
      ],
    },
  },
  methods: {
    sendSMS(args = {}) {
      return this.app.create({
        path: "/simple/transactional",
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      number,
      text,
      unicode,
      senderId,
      senderIdValue,
      country,
      appId,
      appToken,
    } = this;

    const response = await this.sendSMS({
      step,
      data: {
        number,
        text,
        unicode,
        sender_id: senderId,
        sender_id_value: senderIdValue,
        country,
        appId,
        appToken,
      },
    });

    step.export("$summary", `Successfully sent SMS with ID ${response.data.sms_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
BulkGate	`app`	`app`	This component uses the BulkGate app.
Recipient Number	`number`	`string`	The phone number you want to send the SMS to.
Message Text	`text`	`string`	Text of SMS message (max. 612 characters, or 268 characters if Unicode is used), UTF-8 encoding
Is Unicode	`unicode`	`boolean`	`Yes/true/1` for Unicode SMS, `no/false/0` for 7bit SMS.
Sender ID	`senderId`	`string`	Select a value from the drop down menu:`{ "label": "System Number", "value": "gSystem" }{ "label": "Short Code", "value": "gShort" }{ "label": "Text sender", "value": "gText" }{ "label": "Mobile Connect", "value": "gMobile" }{ "label": "Mobile Connect push - Sends a notification to the Mobile Connect app", "value": "gPush" }{ "label": "Own Number (number verification required)", "value": "gOwn" }{ "label": "BulkGate Profile ID", "value": "gProfile" }{ "label": "BulkGate Profile ID", "value": "<int>" }`
Sender ID Value	`senderIdValue`	`string`	Sender value - gOwn (e.g. `420 777 777 777`), gText (e.g. `BulkGate`), gProfile (e.g. `423`), gMobile or gPush (`KEY`).
Country	`country`	`string`	Provide the recipients numbers in an international format (with prefix, e.g. `44`) or add the country code in ISO 3166-1 alpha-2 format (`7820125799` + `GB` = `447820125799`). See the country example request. If `null`, your set timezone will be used to fill the information
Application ID	`appId`	`string`	The ID of the application you want to use to send the SMS.
Application Token	`appToken`	`string`	The token of the application you want to use to send the SMS.

Action Authentication#

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

You can get your App ID and Token on your Dashboard > Modules & APIs.