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

Pipedream makes it easy to connect APIs for LabsMobile, 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 SMS with the LabsMobile 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 LabsMobile 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 SMS action
1. Connect your LabsMobile account
2. Configure Msisdn
3. Configure Message
4. Optional- Configure Tpoa
5. Optional- Configure Subid
6. Optional- Configure Label
7. Optional- Configure Test
8. Optional- Configure Ackurl
9. Optional- Configure Shortlink
10. Optional- Configure Click URL
11. Optional- Configure Scheduled
12. Optional- Configure Long
13. Optional- Configure CRT
14. Optional- Configure CRT ID
15. Optional- Configure CRT Name
16. Optional- Configure UCS 2
17. Optional- Configure No Filter
18. Optional- Configure Parameters
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 SMS on LabsMobile

Description:Sends a new SMS message. [See the documentation](https://apidocs.labsmobile.com/)

Version:0.0.1

Key:labsmobile-send-sms

View on GitHub

LabsMobile Overview#

LabsMobile API enables seamless SMS messaging for various applications, perfect for notifications, authentication, or marketing. Through Pipedream, you can integrate LabsMobile with countless services and trigger SMS workflows using HTTP requests, scheduled jobs, or event-based setups. Pipedream's serverless platform simplifies these processes, allowing you to focus on building efficient, scalable messaging pipelines.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { parseObject } from "../../common/utils.mjs";
import labsmobile from "../../labsmobile.app.mjs";

export default {
  key: "labsmobile-send-sms",
  name: "Send SMS",
  description: "Sends a new SMS message. [See the documentation](https://apidocs.labsmobile.com/)",
  version: "0.0.1",
  type: "action",
  props: {
    labsmobile,
    msisdn: {
      type: "integer[]",
      label: "Msisdn",
      description: "Parameter that includes a mobile number recipient. The number must include the country code without '+' ó '00'. Each customer account has a maximum number of msisdn per sending. See the terms of your account to see this limit.",
    },
    message: {
      type: "string",
      label: "Message",
      description: "The message to be sent. The maximum message length is 160 characters. Only characters in the GSM 3.38 7bit alphabet, found at the end of this document, are valid. Otherwise you must send `ucs2` parameter.",
    },
    tpoa: {
      type: "string",
      label: "Tpoa",
      description: "Sender of the message. May have a numeric (maximum length, 14 digits) or an alphanumeric (maximum capacity, 11 characters) value. The messaging platform assigns a default sender if this parameter is not included. By including the sender's mobile number, the message recipient can easily respond from their mobile phone with the \"Reply\" button. The sender can only be defined in some countries due to the restrictions of the operators. Otherwise the sender is a random numeric value.",
      optional: true,
    },
    subid: {
      type: "string",
      label: "Subid",
      description: "Message ID included in the ACKs (delivery confirmations). It is a unique delivery ID issued by the API client. It has a maximum length of 20 characters.",
      optional: true,
    },
    label: {
      type: "string",
      label: "Label",
      description: "Identifies the message for statistical purposes. WebSMS and other applications use this field to organize and record the message. Maximum capacity of 255 characters. Typical information contained in this field: user that has sent the message, application or module, etc. ...",
      optional: true,
    },
    test: {
      type: "boolean",
      label: "Test",
      description: "If the value is `true`, the message will be considered a test. It will not be sent to the GSM network and, therefore, will not be received on any mobile devices. However, these messages are accessible using online search tools. This parameter is intended to enable performing integration tests without an associated cost. Operator and handset confirmations will not be received.",
      optional: true,
    },
    ackurl: {
      type: "string",
      label: "Ackurl",
      description: "URL to which the corresponding delivery confirmation notifications will be sent. In the preferences section of WebSMS application you can set the default value for ackurl for all cases without having to send this parameter in each sending.",
      optional: true,
    },
    shortlink: {
      type: "boolean",
      label: "Shortlink",
      description: "If this field is present in the message and has a value of `true` the first URL would be replace by a short link of LabsMobile (format: http://lm0.es/XXXXX). The statistics of visits can be seen in WebSMS application or can be received in an url with the parameter clickurl.",
      optional: true,
    },
    clickurl: {
      type: "string",
      label: "Click URL",
      description: "URL to which the corresponding click confirmation notifications will be sent if the parameter shortlink is enabled. In the preferences section of WebSMS application you can set the default value for clickurl for all cases without having to send this parameter in each sending.",
      optional: true,
    },
    scheduled: {
      type: "string",
      label: "Scheduled",
      description: "The message will be sent at the date and time indicated in this field. If this field has not been specified, the message will be sent immediately. Format: YYYY-MM-DD HH:MM:SS. **IMPORTANT: the value of this field must be expressed using GMT time.**",
      optional: true,
    },
    long: {
      type: "boolean",
      label: "Long",
      description: "If this field is present in the message and has a value of `true`, the message field may contain up to 459 characters. Each 153 characters will be considered a single message (in terms of charges) and the recipient will receive one, concatenated message. **IMPORTANT: This option is only available in some countries due to the restrictions of the operators.**",
      optional: true,
    },
    crt: {
      type: "string",
      label: "CRT",
      description: "If this field is present in the message, it will be considered a certified SMS message. An email with the delivery certificate in an attachment will be sent to the address contained in this parameter. **IMPORTANT: This option is only implemented in some countries.**",
      optional: true,
    },
    crtId: {
      type: "string",
      label: "CRT ID",
      description: "If the message is a certified SMS message this field will be set as the tax identification number of the sender company or organization. You would see this value in the certificate in PDF format.",
      optional: true,
    },
    crtName: {
      type: "string",
      label: "CRT Name",
      description: "If the message is a certified SMS message this field will be set as the name of the sender company or organization. You would see this value in the certificate in PDF format.",
      optional: true,
    },
    ucs2: {
      type: "boolean",
      label: "UCS 2",
      description: "If this field is present in the message the message can contain any character in the UCS-2 alphabet. In this case the capacity of the message is 70 characters and can be sent concatenated to a maximum of 500 characters.",
      optional: true,
    },
    nofilter: {
      type: "boolean",
      label: "No Filter",
      description: "If this field is present the platform won't apply the duplicate filter, so no message will be blocked by this filter.",
      optional: true,
    },
    parameters: {
      type: "object",
      label: "Parameters",
      description: "This field contains values to replace parameters in the text of the message. The message can contain one or more parameters (with the following format: **%name%**, **%fieldn%**, etc.). It is necessary to specify the value of each parameter for each of the recipients or establish a default value. Example: **{\"parameters\": [{\"name\": {\"msisdn\":\"12015550123\", \"value\":\"John\"}}, {\"name\": {\"msisdn\":\"default\", \"value\":\"Client\"}}]}**",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      labsmobile,
      msisdn,
      parameters,
      crtId,
      crtName,
      ...data
    } = this;

    const response = await labsmobile.sendSMS({
      $,
      data: {
        recipient: parseObject(msisdn).map((item) => ({
          msisdn: item,
        })),
        parameters: parameters && parseObject(parameters),
        crt_id: crtId,
        crt_name: crtName,
        ...data,
      },
    });

    if (response.code != "0") {
      throw new ConfigurationError(response.message);
    }

    $.export("$summary", `Successfully sent SMS with Id: ${response.subid}`);
    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
LabsMobile	`labsmobile`	`app`	This component uses the LabsMobile app.
Msisdn	`msisdn`	`integer[]`	Parameter that includes a mobile number recipient. The number must include the country code without '+' ó '00'. Each customer account has a maximum number of msisdn per sending. See the terms of your account to see this limit.
Message	`message`	`string`	The message to be sent. The maximum message length is 160 characters. Only characters in the GSM 3.38 7bit alphabet, found at the end of this document, are valid. Otherwise you must send `ucs2` parameter.
Tpoa	`tpoa`	`string`	Sender of the message. May have a numeric (maximum length, 14 digits) or an alphanumeric (maximum capacity, 11 characters) value. The messaging platform assigns a default sender if this parameter is not included. By including the sender's mobile number, the message recipient can easily respond from their mobile phone with the "Reply" button. The sender can only be defined in some countries due to the restrictions of the operators. Otherwise the sender is a random numeric value.
Subid	`subid`	`string`	Message ID included in the ACKs (delivery confirmations). It is a unique delivery ID issued by the API client. It has a maximum length of 20 characters.
Label	`label`	`string`	Identifies the message for statistical purposes. WebSMS and other applications use this field to organize and record the message. Maximum capacity of 255 characters. Typical information contained in this field: user that has sent the message, application or module, etc. ...
Test	`test`	`boolean`	If the value is `true`, the message will be considered a test. It will not be sent to the GSM network and, therefore, will not be received on any mobile devices. However, these messages are accessible using online search tools. This parameter is intended to enable performing integration tests without an associated cost. Operator and handset confirmations will not be received.
Ackurl	`ackurl`	`string`	URL to which the corresponding delivery confirmation notifications will be sent. In the preferences section of WebSMS application you can set the default value for ackurl for all cases without having to send this parameter in each sending.
Shortlink	`shortlink`	`boolean`	If this field is present in the message and has a value of `true` the first URL would be replace by a short link of LabsMobile (format: http://lm0.es/XXXXX). The statistics of visits can be seen in WebSMS application or can be received in an url with the parameter clickurl.
Click URL	`clickurl`	`string`	URL to which the corresponding click confirmation notifications will be sent if the parameter shortlink is enabled. In the preferences section of WebSMS application you can set the default value for clickurl for all cases without having to send this parameter in each sending.
Scheduled	`scheduled`	`string`	The message will be sent at the date and time indicated in this field. If this field has not been specified, the message will be sent immediately. Format: YYYY-MM-DD HH:MM:SS. IMPORTANT: the value of this field must be expressed using GMT time.
Long	`long`	`boolean`	If this field is present in the message and has a value of `true`, the message field may contain up to 459 characters. Each 153 characters will be considered a single message (in terms of charges) and the recipient will receive one, concatenated message. IMPORTANT: This option is only available in some countries due to the restrictions of the operators.
CRT	`crt`	`string`	If this field is present in the message, it will be considered a certified SMS message. An email with the delivery certificate in an attachment will be sent to the address contained in this parameter. IMPORTANT: This option is only implemented in some countries.
CRT ID	`crtId`	`string`	If the message is a certified SMS message this field will be set as the tax identification number of the sender company or organization. You would see this value in the certificate in PDF format.
CRT Name	`crtName`	`string`	If the message is a certified SMS message this field will be set as the name of the sender company or organization. You would see this value in the certificate in PDF format.
UCS 2	`ucs2`	`boolean`	If this field is present in the message the message can contain any character in the UCS-2 alphabet. In this case the capacity of the message is 70 characters and can be sent concatenated to a maximum of 500 characters.
No Filter	`nofilter`	`boolean`	If this field is present the platform won't apply the duplicate filter, so no message will be blocked by this filter.
Parameters	`parameters`	`object`	This field contains values to replace parameters in the text of the message. The message can contain one or more parameters (with the following format: %name%, %fieldn%, etc.). It is necessary to specify the value of each parameter for each of the recipients or establish a default value. Example: {"parameters": [{"name": {"msisdn":"12015550123", "value":"John"}}, {"name": {"msisdn":"default", "value":"Client"}}]}

Action Authentication#

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

LabsMobile requires their users enter their LabsMobile email and password (or API token) in order to connect to their API. For more info, refer to LabsMobile’s documentation.

To retrieve your API token,

Navigate to your LabsMobile and sign in
Go to “Support” > “API parameters”

About LabsMobile#

LabsMobile.com is a leading provider of SMS communication services. We help any company or organization of any sector, size and country to have better and more efficient communications.