Create Order with Order Desk API on New Created or Updated Event (Instant) from Google Calendar API

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

Trigger workflow on

New Created or Updated Event (Instant) from the Google Calendar API

Next, do this

Create Order 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 Google Calendar 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 Created or Updated Event (Instant) trigger
1. Connect your Google Calendar account
2. Optional- Select one or more Calendars
3. Optional- Configure Emit only for new events
4. Configure Push notification renewal schedule
Configure the Create Order action
1. Connect your Order Desk account
2. Configure Order Items
3. Optional- Configure Customer First Name
4. Optional- Configure Customer Last Name
5. Optional- Configure Customer Company
6. Optional- Configure Shipping First Name
7. Optional- Configure Shipping Last Name
8. Optional- Configure Shipping Company
9. Optional- Configure Source ID
10. Optional- Select a Source Name
11. Optional- Configure Email
12. Optional- Configure Shipping Method
13. Optional- Configure Quantity Total
14. Optional- Configure Weight Total
15. Optional- Configure Product Total
16. Optional- Configure Shipping Total
17. Optional- Configure Handling Total
18. Optional- Configure Tax Total
19. Optional- Configure Discount Total
20. Optional- Configure Order Total
21. Optional- Configure Credit Card Number
22. Optional- Configure Credit Card Expiration
23. Optional- Configure Processor Response
24. Optional- Configure Payment Type
25. Optional- Select a Payment Status
26. Optional- Configure Processor Balance
27. Optional- Configure Refund Total
28. Optional- Configure Customer ID
29. Optional- Configure IP Address
30. Optional- Configure Fulfillment ID
31. Optional- Configure Fulfillment Name
32. Optional- Configure Folder ID
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 Created or Updated Event (Instant) on Google Calendar

Description:Emit new event when a Google Calendar events is created or updated (does not emit cancelled events)

Version:0.1.13

Key:google_calendar-new-or-updated-event-instant

View on GitHub

Google Calendar Overview#

The Google Calendar API lets you dip into the powerhouse of scheduling, allowing for the reading, creation, and manipulation of events and calendars directly from your applications. Through Pipedream, you can seamlessly integrate Google Calendar into a myriad of workflows, automating event management, syncing with other services, setting up custom reminders, or even collating data for reporting. The key here is to streamline your calendar-related processes, ensuring that your time management is as efficient and automated as possible.

Trigger Code#

import { v4 as uuid } from "uuid";
import sampleEmit from "./test-event.mjs";
import googleCalendar from "../../google_calendar.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "google_calendar-new-or-updated-event-instant",
  type: "source",
  name: "New Created or Updated Event (Instant)",
  description: "Emit new event when a Google Calendar events is created or updated (does not emit cancelled events)",
  version: "0.1.13",
  dedupe: "unique",
  props: {
    googleCalendar,
    db: "$.service.db",
    calendarIds: {
      propDefinition: [
        googleCalendar,
        "calendarId",
      ],
      type: "string[]",
      default: [
        "primary",
      ],
      label: "Calendars",
      description: "Select one or more calendars to watch (defaults to the primary calendar)",
    },
    newOnly: {
      label: "Emit only for new events",
      type: "boolean",
      description: "Emit new events only, and not updates to existing events (defaults to `false`)",
      optional: true,
      default: false,
    },
    http: "$.interface.http",
    timer: {
      label: "Push notification renewal schedule",
      description: "The Google Calendar API requires occasional renewal of push notification subscriptions. **This runs in the background, so you should not need to modify this schedule**.",
      type: "$.interface.timer",
      static: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  hooks: {
    async deploy() {
      const events = [];
      const params = {
        maxResults: 25,
        orderBy: "updated",
      };
      for (const calendarId of this.calendarIds) {
        params.calendarId = calendarId;
        const { items } = await this.googleCalendar.listEvents(params);
        events.push(...items);
      }
      events.sort((a, b) => (Date.parse(a.updated) > Date.parse(b.updated))
        ? 1
        : -1);
      for (const event of events.slice(-25)) {
        const meta = this.generateMeta(event);
        this.$emit(event, meta);
      }
    },
    async activate() {
      await this.makeWatchRequest();
    },
    async deactivate() {
      await this.stopWatchRequest();
    },
  },
  methods: {
    setNextSyncToken(calendarId, nextSyncToken) {
      this.db.set(`${calendarId}.nextSyncToken`, nextSyncToken);
    },
    getNextSyncToken(calendarId) {
      return this.db.get(`${calendarId}.nextSyncToken`);
    },
    setChannelId(calendarId, channelId) {
      this.db.set(`${calendarId}.channelId`, channelId);
    },
    getChannelId(calendarId) {
      return this.db.get(`${calendarId}.channelId`);
    },
    setResourceId(calendarId, resourceId) {
      this.db.set(`${calendarId}.resourceId`, resourceId);
    },
    getResourceId(calendarId) {
      return this.db.get(`${calendarId}.resourceId`);
    },
    setExpiration(calendarId, expiration) {
      this.db.set(`${calendarId}.expiration`, expiration);
    },
    getExpiration(calendarId) {
      return this.db.get(`${calendarId}.expiration`);
    },
    /**
     * A utility method to compute whether the provided event is newly created
     * or not. Since the Google Calendar API does not provide a specific way to
     * determine this, this method estimates the result based on the `created`
     * and `updated` timestamps: if they are more than 2 seconds apart, then we
     * assume that the event is not new.
     *
     * @param {Object} event - The calendar event being processed
     * @returns {Boolean} True if the input event is a newly created event, or
     * false otherwise
     */
    _isNewEvent(event) {
      const {
        created,
        updated,
      } = event;
      const createdTimestampMilliseconds = Date.parse(created);
      const updatedTimestampMilliseconds = Date.parse(updated);
      const diffMilliseconds = Math.abs(
        updatedTimestampMilliseconds - createdTimestampMilliseconds,
      );
      const maxDiffMilliseconds = 2000;
      return diffMilliseconds <= maxDiffMilliseconds;
    },
    /**
     * A utility method to compute whether the provided event is relevant to the
     * event source (and as a consequence must be processed) or not.
     *
     * @param {Object} event - The calendar event being processed
     * @returns {Boolean} True if the input event must be processed, or false
     * otherwise (i.e. if the event must be skipped)
     */
    isEventRelevant(event) {
      return !this.newOnly || this._isNewEvent(event);
    },
    generateMeta(event) {
      const {
        id,
        summary,
        updated: tsString,
      } = event;
      const ts = Date.parse(tsString);
      return {
        id: `${id}-${ts}`,
        summary,
        ts,
      };
    },
    async makeWatchRequest() {
      // Make watch request for this HTTP endpoint
      for (const calendarId of this.calendarIds) {
        const watchResp =
          await this.googleCalendar.watchEvents({
            calendarId,
            requestBody: {
              id: uuid(),
              type: "web_hook",
              address: this.http.endpoint,
            },
          });

        // Initial full sync. Get next sync token
        const nextSyncToken = await this.googleCalendar.fullSync(calendarId);

        this.setNextSyncToken(calendarId, nextSyncToken);
        this.setChannelId(calendarId, watchResp.id);
        this.setResourceId(calendarId, watchResp.resourceId);
        this.setExpiration(calendarId, watchResp.expiration);
      }
    },
    async stopWatchRequest() {
      for (const calendarId of this.calendarIds) {
        const id = this.getChannelId(calendarId);
        const resourceId = this.getResourceId(calendarId);
        if (id && resourceId) {
          const { status } =
            await this.googleCalendar.stopChannel({
              returnOnlyData: false,
              requestBody: {
                id,
                resourceId,
              },
            });
          if (status === 204) {
            console.log("webhook deactivated");
            this.setNextSyncToken(calendarId, null);
            this.setChannelId(calendarId, null);
            this.setResourceId(calendarId, null);
            this.setExpiration(calendarId, null);
          } else {
            console.log("There was a problem deactivating the webhook");
          }
        }
      }
    },
    getSoonestExpirationDate() {
      let min;
      for (const calendarId of this.calendarIds) {
        const expiration = parseInt(this.db.get(`${calendarId}.expiration`));
        if (!min || expiration < min) {
          min = expiration;
        }
      }
      return new Date(min);
    },
    getChannelIds() {
      const channelIds = [];
      for (const calendarId of this.calendarIds) {
        const channelId = this.db.get(`${calendarId}.channelId`);
        channelIds.push(channelId);
      }
      return channelIds;
    },
  },
  async run(event) {
    // refresh watch
    if (event.interval_seconds) {
      // get time
      const now = new Date();
      const intervalMs = event.interval_seconds * 1000;
      // get expiration
      const expireDate = this.getSoonestExpirationDate();

      // if now + interval > expiration, refresh watch
      if (now.getTime() + intervalMs > expireDate.getTime()) {
        await this.stopWatchRequest();
        await this.makeWatchRequest();
      }
    } else {
      // Verify channel ID
      const channelIds = this.getChannelIds();
      const incomingChannelId = event?.headers?.["x-goog-channel-id"];
      if (!channelIds.includes(incomingChannelId)) {
        console.log(
          `Unexpected channel ID ${incomingChannelId}. This likely means there are multiple, older subscriptions active.`,
        );
        return;
      }

      // Check that resource state === exists
      const state = event?.headers?.["x-goog-resource-state"];
      switch (state) {
      case "exists":
        // there's something to emit, so keep going
        break;
      case "not_exists":
        console.log("Resource does not exist. Exiting.");
        return;
      case "sync":
        console.log("New channel created");
        return;
      default:
        console.log(`Unknown state: ${state}`);
        return;
      }
    }

    // Fetch and emit events
    for (const calendarId of this.calendarIds) {
      const syncToken = this.getNextSyncToken(calendarId);
      let nextSyncToken = null;
      let nextPageToken = null;
      while (!nextSyncToken) {
        const {
          data: syncData = {},
          status: syncStatus,
        } = await this.googleCalendar.listEvents({
          returnOnlyData: false,
          calendarId,
          syncToken,
          pageToken: nextPageToken,
          maxResults: 2500,
        });
        if (syncStatus === 410) {
          console.log("Sync token invalid, resyncing");
          nextSyncToken = await this.googleCalendar.fullSync(this.calendarId);
          break;
        }
        nextPageToken = syncData.nextPageToken;
        nextSyncToken = syncData.nextSyncToken;

        const { items: events = [] } = syncData;
        events
          .filter(this.isEventRelevant, this)
          .forEach((event) => {
            const { status } = event;
            if (status === "cancelled") {
              console.log("Event cancelled. Exiting.");
              return;
            }
            const meta = this.generateMeta(event);
            this.$emit(event, meta);
          });
      }

      this.setNextSyncToken(calendarId, nextSyncToken);
    }
  },
  sampleEmit,
};

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
Google Calendar	`googleCalendar`	`app`	This component uses the Google Calendar app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Calendars	`calendarIds`	`string[]`	Select a value from the drop down menu.
Emit only for new events	`newOnly`	`boolean`	Emit new events only, and not updates to existing events (defaults to `false`)
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.
Push notification renewal schedule	`timer`	`$.interface.timer`	The Google Calendar API requires occasional renewal of push notification subscriptions. This runs in the background, so you should not need to modify this schedule.

Trigger Authentication#

Google Calendar uses OAuth authentication. When you connect your Google Calendar account, Pipedream will open a popup window where you can sign into Google Calendar and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Calendar API.

Pipedream requests the following authorization scopes when you connect your account:

https://www.googleapis.com/auth/calendar.eventshttps://www.googleapis.com/auth/calendar.readonlyhttps://www.googleapis.com/auth/calendar.settings.readonly

About Google Calendar#

With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.

Action#

Create Order on Order Desk

Description:Create Order [See the documentation](https://apidocs.orderdesk.com/#create-an-order).

Version:0.0.1

Key:order_desk-create-order

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 { getParsedOrderItems } from "../../common/validate-order-items.mjs";
import app  from "../../order_desk.app.mjs";

export default {
  name: "Create Order",
  description: "Create Order [See the documentation](https://apidocs.orderdesk.com/#create-an-order).",
  key: "order_desk-create-order",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    order_items: {
      propDefinition: [
        app,
        "order_items",
      ],
    },
    customer_first_name: {
      propDefinition: [
        app,
        "customer_first_name",
      ],
    },
    customer_last_name: {
      propDefinition: [
        app,
        "customer_last_name",
      ],
    },
    customer_company: {
      propDefinition: [
        app,
        "customer_company",
      ],
    },
    shipping_first_name: {
      propDefinition: [
        app,
        "shipping_first_name",
      ],
    },
    shipping_last_name: {
      propDefinition: [
        app,
        "shipping_last_name",
      ],
    },
    shipping_company: {
      propDefinition: [
        app,
        "shipping_company",
      ],
    },
    source_id: {
      propDefinition: [
        app,
        "source_id",
      ],
    },
    source_name: {
      propDefinition: [
        app,
        "source_name",
      ],
    },
    email: {
      propDefinition: [
        app,
        "email",
      ],
    },
    shipping_method: {
      propDefinition: [
        app,
        "shipping_method",
      ],
    },
    quantity_total: {
      propDefinition: [
        app,
        "quantity_total",
      ],
    },
    weight_total: {
      propDefinition: [
        app,
        "weight_total",
      ],
    },
    product_total: {
      propDefinition: [
        app,
        "product_total",
      ],
    },
    shipping_total: {
      propDefinition: [
        app,
        "shipping_total",
      ],
    },
    handling_total: {
      propDefinition: [
        app,
        "handling_total",
      ],
    },
    tax_total: {
      propDefinition: [
        app,
        "tax_total",
      ],
    },
    discount_total: {
      propDefinition: [
        app,
        "discount_total",
      ],
    },
    order_total: {
      propDefinition: [
        app,
        "order_total",
      ],
    },
    cc_number: {
      propDefinition: [
        app,
        "cc_number",
      ],
    },
    cc_exp: {
      propDefinition: [
        app,
        "cc_exp",
      ],
    },
    processor_response: {
      propDefinition: [
        app,
        "processor_response",
      ],
    },
    payment_type: {
      propDefinition: [
        app,
        "payment_type",
      ],
    },
    payment_status: {
      propDefinition: [
        app,
        "payment_status",
      ],
    },
    processor_balance: {
      propDefinition: [
        app,
        "processor_balance",
      ],
    },
    refund_total: {
      propDefinition: [
        app,
        "refund_total",
      ],
    },
    customer_id: {
      propDefinition: [
        app,
        "customer_id",
      ],
    },
    ip_address: {
      propDefinition: [
        app,
        "ip_address",
      ],
    },
    fulfillment_id: {
      propDefinition: [
        app,
        "fulfillment_id",
      ],
    },
    fulfillment_name: {
      propDefinition: [
        app,
        "fulfillment_name",
      ],
    },
    folder_id: {
      propDefinition: [
        app,
        "folder_id",
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      ...data
    } = this;

    const res = await app.createOrder({
      ...data,
      order_items: getParsedOrderItems(data.order_items),
    });
    $.export("summary", `Order successfully created with id "${res.order.id}".`);
    return res;
  },
};

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.
Order Items	`order_items`	`string[]`	A valid JSON string. Order Items Object can have the following properties: `id, name, price, quantity, weight, code, delivery_type, category_code, variation_list, metadata`. Please check the documentation in the description for more information.
Customer First Name	`customer_first_name`	`string`	Customer first name
Customer Last Name	`customer_last_name`	`string`	Customer last name
Customer Company	`customer_company`	`string`	Customer company
Shipping First Name	`shipping_first_name`	`string`	Shipping first name
Shipping Last Name	`shipping_last_name`	`string`	Shipping last name
Shipping Company	`shipping_company`	`string`	Shipping company
Source ID	`source_id`	`string`	Your order ID. If blank, Order Desk's internal ID will be used read-only.
Source Name	`source_name`	`string`	Select a value from the drop down menu:`Order DeskFoxyCartWooCommerceBigCommerceAmazonShopifyeBayMagentoMagento 2GumroadWufooInterspirePayPalStripeEtsyJetZapierSpark PaySnipcartRecurlyVolusionChargebeeWeeblyWalmartWalmart.comModular MerchantEcwidUltraCartnopCommerceSquarespaceCeleryE-junkieCommerceHQBrightStoresSamCartWayfairSpree`
Email	`email`	`string`	Customer email address
Shipping Method	`shipping_method`	`string`	Name of shipping method selected.
Quantity Total	`quantity_total`	`string`	Total number of items in the order.
Weight Total	`weight_total`	`string`	Total weight of the order.
Product Total	`product_total`	`string`	Total cost of all items in the order.
Shipping Total	`shipping_total`	`string`	Total cost of shipping.
Handling Total	`handling_total`	`string`	Total cost of handling.
Tax Total	`tax_total`	`string`	Total cost of tax.
Discount Total	`discount_total`	`string`	Total cost of discounts.
Order Total	`order_total`	`string`	Total cost of the order.
Credit Card Number	`cc_number`	`string`	Obfuscated credit card number. Enter only the last four digits.
Credit Card Expiration	`cc_exp`	`string`	Credit card expiration date in MM/YYYY format.
Processor Response	`processor_response`	`string`	Gateway transaction ID in format `<gateway_name>: <transaction_id>`
Payment Type	`payment_type`	`string`	Payment type. Can be `Visa`, `Paypal`, `Mastercard`, etc
Payment Status	`payment_status`	`string`	Select a value from the drop down menu:`ApprovedAuthorizedCapturedFully RefundedPartially RefundedPendingRejectedVoided`
Processor Balance	`processor_balance`	`string`	The amount that the was charged at the processor. This amount will be decremented when refunds are made. By default it will be set the same as `order_total`
Refund Total	`refund_total`	`string`	The amount that jhas been refunded on the order from within Order Desk. This is generally something that will be set internally.
Customer ID	`customer_id`	`string`	The ID of the customer. This is generally something that will be set internally.
IP Address	`ip_address`	`string`	The IP address of the customer.
Fulfillment ID	`fulfillment_id`	`string`	The internal ID of the fulfillment service will be saved here for some services.
Fulfillment Name	`fulfillment_name`	`string`	Once the order has been sent for fulfillment, the name of the fulfillment method is entered here.
Folder ID	`folder_id`	`string`	The ID number of the folder in which the order is stored. If nothing is entered when adding an order, the folder will be the first folder in the list.

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 + Google Calendar#

Other Popular Integrations#

Find Order with Order Desk API on New Cancelled Event from Google Calendar API

Google Calendar + Order Desk

Create Order with Order Desk API on New Created or Updated Event (Instant) from Google Calendar API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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