List Orders with Order Desk API on New Incoming SMS (Instant) from Twilio API

Pipedream makes it easy to connect APIs for Order Desk, Twilio and 2,200+ other apps remarkably fast.

Trigger workflow on

New Incoming SMS (Instant) from the Twilio API

Next, do this

List Orders with the Order Desk 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 Twilio trigger and Order Desk action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Incoming SMS (Instant) trigger
1. Connect your Twilio account
2. Select a Incoming Phone Number
3. Optional- Configure Response Message
Configure the List Orders action
1. Connect your Order Desk account
2. Optional- Configure Search Start Date Local
3. Optional- Configure Search End Date Local
4. Optional- Configure Search Start Date
5. Optional- Configure Search End Date
6. Optional- Configure Modified Start Date
7. Optional- Configure Modified End Date
8. Optional- Configure Order By
9. Optional- Select a Order
10. Optional- Configure Folder ID
11. Optional- Configure Folder Name
12. Optional- Configure Source ID
13. Optional- Select a Source Name
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 Incoming SMS (Instant) on Twilio

Description:Emit new event every time an SMS is sent to the phone number set. Configures a webhook in Twilio, tied to an incoming phone number.

Version:0.1.4

Key:twilio-new-incoming-sms

View on GitHub

Twilio Overview#

Twilio's API on Pipedream opens up a multitude of communication capabilities, allowing you to build robust, scalable, and automated workflows. With Twilio, you can send and receive SMS and MMS messages, make voice calls, and perform other communication functions programmatically. Leveraging Pipedream's seamless integration, you can connect these communications features with hundreds of other services to automate notifications, streamline customer interactions, and enhance operational efficiency.

Trigger Code#

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

const MessagingResponse = twilio.twiml.MessagingResponse;

export default {
  ...common,
  key: "twilio-new-incoming-sms",
  name: "New Incoming SMS (Instant)",
  description: "Emit new event every time an SMS is sent to the phone number set. Configures a webhook in Twilio, tied to an incoming phone number.",
  version: "0.1.4",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    responseMessage: {
      propDefinition: [
        common.props.twilio,
        "responseMessage",
      ],
    },
  },
  methods: {
    ...common.methods,
    getServiceType() {
      return constants.SERVICE_TYPE.SMS;
    },
    getResponseBody() {
      const twiml = new MessagingResponse();
      let responseBody = "<Response></Response>";
      if (this.responseMessage) {
        twiml.message(this.responseMessage);
        responseBody = twiml.toString();
      }
      return responseBody;
    },
    generateMeta(body, headers) {
      return {
        /** if Twilio retries a message, but we've already emitted, dedupe */
        id: headers["i-twilio-idempotency-token"],
        summary: body.Body,
        ts: Date.now(),
      };
    },
  },
};

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
Twilio	`twilio`	`app`	This component uses the Twilio app.
Incoming Phone Number	`incomingPhoneNumber`	`string`	Select a value from the drop down menu.
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.
Response Message	`responseMessage`	`string`	The message you want to send in response to incoming messages. Leave this blank if you don't need to issue a response.

Trigger Authentication#

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

To connect your Twilio account to Pipedream,

API Key and API Key SID

First, create an API key in Twilio.

There are three types of keys: Main, Standard, and Restricted. You'll need a Main key to interact with certain API endpoints, like /Accounts.
If you don't need to interact with those endpoints, you can use a Standard or Restricted key.

After creating your key, you'll see fields for Sid and Secret. Enter those in the fields below.

Account SID and Auth Token

Visit your Twilio Dashboard. You'll see your Account SID and Auth Token under Account info.

About Twilio#

Twilio is a cloud communications platform for building SMS, Voice & Messaging applications on an API built for global scale.

Action#

List Orders on Order Desk

Description:List Orders based on a search criteria [See the documentation](https://apidocs.orderdesk.com/#get-multiple-orders).

Version:0.0.1

Key:order_desk-list-orders

View on GitHub

Order Desk Overview#

The Order Desk API allows you to automate and streamline order management processes within the Order Desk platform. With this API, you have the power to create, update, and get detailed information on orders, inventory, and shipments. Pipedream's serverless platform enables you to connect the Order Desk API with numerous other apps and services to build dynamic workflows. Whether you're syncing order data, managing inventory, or connecting to fulfillment services, Pipedream can help you craft custom automations that save time and reduce manual errors.

Action Code#

import options from "../../common/options.mjs";
import app from "../../order_desk.app.mjs";

export default {
  name: "List Orders",
  description: "List Orders based on a search criteria [See the documentation](https://apidocs.orderdesk.com/#get-multiple-orders).",
  key: "order_desk-list-orders",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    search_start_date_local: {
      type: "string",
      label: "Search Start Date Local",
      description: "Start date from when an order was added. Search in local store time.",
      optional: true,
    },
    search_end_date_local: {
      type: "string",
      label: "Search End Date Local",
      description: "End date from when an order was added. Search in local store time.",
      optional: true,
    },
    search_start_date: {
      type: "string",
      label: "Search Start Date",
      description: "Start date from when an order was added. Search in UTC time.",
      optional: true,
    },
    search_end_date: {
      type: "string",
      label: "Search End Date",
      description: "End date from when an order was added. Search in UTC time.",
      optional: true,
    },
    modified_start_date: {
      type: "string",
      label: "Modified Start Date",
      description: "Start date from when an order was last modified. Search in UTC time.",
      optional: true,
    },
    modified_end_date: {
      type: "string",
      label: "Modified End Date",
      description: "End date from when an order was last modified. Search in UTC time.",
      optional: true,
    },
    order_by: {
      type: "string",
      label: "Order By",
      description: "Order the query by an order field. Defaults to `date_added`",
      optional: true,
    },
    order: {
      type: "string",
      label: "Order",
      description: "Order the query by `asc` or `desc`. Defaults to `desc`",
      options: options.orderDir,
      optional: true,
    },
    folder_id: {
      propDefinition: [
        app,
        "folder_id",
      ],
      description: "Search for orders from a particular folder. For multiple folders, enter multiple ID's separated by a comma: `1004,1009,1010`",
    },
    folder_name: {
      type: "string",
      label: "Folder Name",
      description: "Search for orders from a particular folder. Enter the folder's exact name instead of its ID.",
      optional: true,
    },
    source_id: {
      propDefinition: [
        app,
        "source_id",
      ],
      description: "The Source Id",
    },
    source_name: {
      propDefinition: [
        app,
        "source_name",
      ],
      description: "The Source Name",
    },
  },
  async run({ $ }) {
    const {
      app,
      ...params
    } = this;
    const data = [];
    let page = 0;
    while (true) {
      const res = await app.listOrders(page, params);
      if (res.orders.length === 0) {
        break;
      }
      data.push(...res.orders);
      page++;
    }

    $.export("summary", `Successfully retrieved ${data.length} order(s).`);
    return data;
  },
};

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
Order Desk	`app`	`app`	This component uses the Order Desk app.
Search Start Date Local	`search_start_date_local`	`string`	Start date from when an order was added. Search in local store time.
Search End Date Local	`search_end_date_local`	`string`	End date from when an order was added. Search in local store time.
Search Start Date	`search_start_date`	`string`	Start date from when an order was added. Search in UTC time.
Search End Date	`search_end_date`	`string`	End date from when an order was added. Search in UTC time.
Modified Start Date	`modified_start_date`	`string`	Start date from when an order was last modified. Search in UTC time.
Modified End Date	`modified_end_date`	`string`	End date from when an order was last modified. Search in UTC time.
Order By	`order_by`	`string`	Order the query by an order field. Defaults to `date_added`
Order	`order`	`string`	Select a value from the drop down menu:`ascdesc`
Folder ID	`folder_id`	`string`	Search for orders from a particular folder. For multiple folders, enter multiple ID's separated by a comma: `1004,1009,1010`
Folder Name	`folder_name`	`string`	Search for orders from a particular folder. Enter the folder's exact name instead of its ID.
Source ID	`source_id`	`string`	The Source Id
Source Name	`source_name`	`string`	Select a value from the drop down menu:`Order DeskFoxyCartWooCommerceBigCommerceAmazonShopifyeBayMagentoMagento 2GumroadWufooInterspirePayPalStripeEtsyJetZapierSpark PaySnipcartRecurlyVolusionChargebeeWeeblyWalmartWalmart.comModular MerchantEcwidUltraCartnopCommerceSquarespaceCeleryE-junkieCommerceHQBrightStoresSamCartWayfairSpree`

Action Authentication#

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

To retrieve your API key,

Navigate to your Order Desk account and sign in
Go to “Store Settings” > “API”

About Order Desk#

Save time and use Order Desk to automate your ecommerce order management workflow with 300+ integrations and counting!

More Ways to Connect Order Desk + Twilio#

Other Popular Integrations#

Find Order with Order Desk API on New Call (Instant) from Twilio API

Twilio + Order Desk