Send SMS with LabsMobile API on New Cancelled Order (Instant) from Shopify API

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

Trigger workflow on

New Cancelled Order (Instant) from the Shopify 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 Shopify 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 Cancelled Order (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
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 Cancelled Order (Instant) on Shopify

Description:Emit new event each time a new order is cancelled.

Version:0.0.4

Key:shopify_developer_app-new-cancelled-order

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration.

Trigger Code#

import constants from "../common/constants.mjs";
import common from "../common/webhook-metafields.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-cancelled-order",
  name: "New Cancelled Order (Instant)",
  type: "source",
  description: "Emit new event each time a new order is cancelled.",
  version: "0.0.4",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.ORDERS_CANCELLED;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.updated_at);
      return {
        id: ts,
        summary: `Order Cancelled ${resource.id}.`,
        ts,
      };
    },
  },
};

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
Shopify	`app`	`app`	This component uses the Shopify 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.
Metafield Namespaces	`metafieldNamespaces`	`string[]`	Array of namespaces for any metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.

Trigger Authentication#

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

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here.

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

About Shopify#

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

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”

Send SMS with LabsMobile API on New Cancelled Order (Instant) from Shopify API

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

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular