List Orders with Order Desk API on New Events (Instant) from Twilio SendGrid API

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

Trigger workflow on

New Events (Instant) from the Twilio SendGrid 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 SendGrid 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 Events (Instant) trigger
1. Connect your Twilio SendGrid account
2. Select one or more Event Types
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 Events (Instant) on Twilio SendGrid

Description:Emit new event when any of the specified SendGrid events is received

Version:0.0.6

Key:sendgrid-events

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import common from "../common/http-based.mjs";
import deliveryEventTypes from "./delivery-event-types.mjs";
import engagementEventTypes from "./engagement-event-types.mjs";

export default {
  ...common,
  key: "sendgrid-events",
  name: "New Events (Instant)",
  description: "Emit new event when any of the specified SendGrid events is received",
  version: "0.0.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    eventTypes: {
      type: "string[]",
      label: "Event Types",
      description: "The type of events to listen to",
      options(context) {
        const { page } = context;
        if (page !== 0) {
          return {
            options: [],
          };
        }

        const options = [
          ...deliveryEventTypes,
          ...engagementEventTypes,
        ];
        return {
          options,
        };
      },
    },
  },
  methods: {
    ...common.methods,
    baseWebhookSettings() {
      // The list of events that a webhook can listen to. This method returns an
      // exhaustive list of all such flags disabled, and each event source can
      // then override the flags that are relevant to the event they handle.
      //
      // See the docs for more information:
      // https://sendgrid.com/docs/api-reference/
      const eventTypesData = [
        ...deliveryEventTypes,
        ...engagementEventTypes,
      ];
      return eventTypesData.reduce((accum, eventTypeData) => ({
        ...accum,
        [eventTypeData.value]: false,
      }), {});
    },
    webhookEventFlags() {
      return this.eventTypes.reduce((accum, eventType) => ({
        ...accum,
        [eventType]: true,
      }), {});
    },
    generateMeta(data) {
      const {
        event: eventType,
        sg_event_id: id,
        timestamp: ts,
      } = data;
      const summary = `New event: ${eventType}`;
      return {
        id,
        summary,
        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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
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.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

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,