Create Shipment with UPS API on New Created or Updated Event (Instant) from Google Calendar API

Pipedream makes it easy to connect APIs for UPS, Google Calendar and 3,000+ other apps remarkably fast.

Trigger workflow on

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

Next, do this

Create Shipment with the UPS 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 UPS 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 Shipment action
1. Connect your UPS account
2. Configure Shipper Name
3. Configure Shipper Number
4. Configure Shipper Address Line
5. Configure Shipper City
6. Configure Shipper State Province Code
7. Configure Shipper Postal Code
8. Configure Shipper Country Code
9. Configure Ship To Name
10. Configure Ship To Address Line
11. Configure Ship To City
12. Configure Ship To State Province Code
13. Configure Ship To Postal Code
14. Configure Ship To Country Code
15. Select a Service Code
16. Select a Packaging Code
17. Select a Weight Unit
18. Configure Package Weight
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.16

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 constants from "../../common/constants.mjs";

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.16",
  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: constants.WEBHOOK_SUBSCRIPTION_RENEWAL_SECONDS,
      },
    },
  },
  hooks: {
    async deploy() {
      const events = [];
      const params = {
        maxResults: 25,
        orderBy: "updated",
        timeMin: new Date(new Date().setMonth(new Date().getMonth() - 1)).toISOString(), // 1 month ago
      };
      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() {
      try {
        await this.stopWatchRequest();
      } catch (e) {
        console.log(`Error deactivating webhook. ${e}`);
      }
    },
  },
  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);
    },
    getCalendarIdForChannelId(incomingChannelId) {
      for (const calendarId of this.calendarIds) {
        if (this.db.get(`${calendarId}.channelId`) === incomingChannelId) {
          return calendarId;
        }
      }
      return null;
    },
  },
  async run(event) {
    let calendarId = null; // calendar ID matching incoming channel ID

    // 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 incomingChannelId = event?.headers?.["x-goog-channel-id"];
      calendarId = this.getCalendarIdForChannelId(incomingChannelId);
      if (!calendarId) {
        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
    const checkCalendarIds = calendarId
      ? [
        calendarId,
      ]
      : this.calendarIds;
    for (const calendarId of checkCalendarIds) {
      const syncToken = this.getNextSyncToken(calendarId);
      let nextSyncToken = null;
      let nextPageToken = null;
      while (!nextSyncToken) {
        try {
          const { data: syncData = {} } = await this.googleCalendar.listEvents({
            returnOnlyData: false,
            calendarId,
            syncToken,
            pageToken: nextPageToken,
            maxResults: 2500,
          });

          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);
            });
        } catch (error) {
          if (error === "Sync token is no longer valid, a full sync is required.") {
            console.log("Sync token invalid, resyncing");
            nextSyncToken = await this.googleCalendar.fullSync(calendarId);
            break;
          } else {
            throw error;
          }
        }
      }

      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.readonlyemailprofile

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 Shipment on UPS

Description:Create a new shipment. [See the documentation](https://developer.ups.com/tag/Shipping?loc=en_US#operation/Shipment)

Version:0.0.1

Key:ups-create-shipment

View on GitHub

Action Code#

import ups from "../../ups.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "ups-create-shipment",
  name: "Create Shipment",
  description: "Create a new shipment. [See the documentation](https://developer.ups.com/tag/Shipping?loc=en_US#operation/Shipment)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    ups,
    shipperName: {
      type: "string",
      label: "Shipper Name",
      description: "The name of the shipper",
    },
    shipperNumber: {
      type: "string",
      label: "Shipper Number",
      description: "Shipper's six digit alphanumeric account number",
    },
    shipperAddressLine: {
      type: "string",
      label: "Shipper Address Line",
      description: "The address line of the shipper",
    },
    shipperCity: {
      type: "string",
      label: "Shipper City",
      description: "The city of the shipper",
    },
    shipperStateProvinceCode: {
      type: "string",
      label: "Shipper State Province Code",
      description: "The state province code of the shipper",
    },
    shipperPostalCode: {
      type: "string",
      label: "Shipper Postal Code",
      description: "The postal code of the shipper",
    },
    shipperCountryCode: {
      type: "string",
      label: "Shipper Country Code",
      description: "The country code of the shipper",
    },
    shipToName: {
      type: "string",
      label: "Ship To Name",
      description: "The name of the ship to",
    },
    shipToAddressLine: {
      type: "string",
      label: "Ship To Address Line",
      description: "The address line of the ship to",
    },
    shipToCity: {
      type: "string",
      label: "Ship To City",
      description: "The city of the ship to",
    },
    shipToStateProvinceCode: {
      type: "string",
      label: "Ship To State Province Code",
      description: "The state province code of the ship to",
    },
    shipToPostalCode: {
      type: "string",
      label: "Ship To Postal Code",
      description: "The postal code of the ship to",
    },
    shipToCountryCode: {
      type: "string",
      label: "Ship To Country Code",
      description: "The country code of the ship to",
    },
    serviceCode: {
      type: "string",
      label: "Service Code",
      description: "The code of the service",
      options: constants.SERVICE_CODES,
    },
    packagingCode: {
      type: "string",
      label: "Packaging Code",
      description: "The code of the packaging",
      options: constants.PACKAGING_CODES,
    },
    weightUnit: {
      type: "string",
      label: "Weight Unit",
      description: "The unit of weight for the package",
      options: [
        "LBS",
        "KGS",
        "OZS",
      ],
    },
    packageWeight: {
      type: "string",
      label: "Package Weight",
      description: "The weight of the package",
    },
  },
  async run({ $ }) {
    const response = await this.ups.createShipment({
      $,
      data: {
        ShipmentRequest: {
          Request: {
            RequestOption: "nonvalidate",
          },
          Shipment: {
            Shipper: {
              Name: this.shipperName,
              ShipperNumber: this.shipperNumber,
              Address: {
                AddressLine: this.shipperAddressLine,
                City: this.shipperCity,
                StateProvinceCode: this.shipperStateProvinceCode,
                PostalCode: this.shipperPostalCode,
                CountryCode: this.shipperCountryCode,
              },
            },
            ShipTo: {
              Name: this.shipToName,
              Address: {
                AddressLine: this.shipToAddressLine,
                City: this.shipToCity,
                StateProvinceCode: this.shipToStateProvinceCode,
                PostalCode: this.shipToPostalCode,
                CountryCode: this.shipToCountryCode,
              },
            },
            PaymentInformation: {
              ShipmentCharge: [
                {
                  Type: "01", // Transportation Charge
                  BillShipper: {
                    AccountNumber: this.shipperNumber,
                  },
                },
              ],
            },
            Service: {
              Code: this.serviceCode,
            },
            Package: [
              {
                Packaging: {
                  Code: this.packagingCode,
                },
                PackageWeight: {
                  UnitOfMeasurement: {
                    Code: this.weightUnit,
                  },
                  Weight: this.packageWeight,
                },
              },
            ],
          },
        },
      },
    });
    $.export("$summary", "Shipment created successfully");
    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
UPS	`ups`	`app`	This component uses the UPS app.
Shipper Name	`shipperName`	`string`	The name of the shipper
Shipper Number	`shipperNumber`	`string`	Shipper's six digit alphanumeric account number
Shipper Address Line	`shipperAddressLine`	`string`	The address line of the shipper
Shipper City	`shipperCity`	`string`	The city of the shipper
Shipper State Province Code	`shipperStateProvinceCode`	`string`	The state province code of the shipper
Shipper Postal Code	`shipperPostalCode`	`string`	The postal code of the shipper
Shipper Country Code	`shipperCountryCode`	`string`	The country code of the shipper
Ship To Name	`shipToName`	`string`	The name of the ship to
Ship To Address Line	`shipToAddressLine`	`string`	The address line of the ship to
Ship To City	`shipToCity`	`string`	The city of the ship to
Ship To State Province Code	`shipToStateProvinceCode`	`string`	The state province code of the ship to
Ship To Postal Code	`shipToPostalCode`	`string`	The postal code of the ship to
Ship To Country Code	`shipToCountryCode`	`string`	The country code of the ship to
Service Code	`serviceCode`	`string`	Select a value from the drop down menu:`{ "value": "01", "label": "Next Day Air" }{ "value": "02", "label": "2nd Day Air" }{ "value": "03", "label": "Ground" }{ "value": "07", "label": "Express" }{ "value": "08", "label": "Expedited" }{ "value": "11", "label": "UPS Standard" }{ "value": "12", "label": "3 Day Select" }{ "value": "13", "label": "Next Day Air Saver" }{ "value": "14", "label": "UPS Next Day Air® Early" }{ "value": "17", "label": "UPS Worldwide Economy DDU" }{ "value": "54", "label": "Express Plus" }{ "value": "59", "label": "2nd Day Air A.M." }{ "value": "65", "label": "UPS Saver" }{ "value": "M2", "label": "First Class Mail" }{ "value": "M3", "label": "Priority Mail" }{ "value": "M4", "label": "Expedited MaiI Innovations" }{ "value": "M5", "label": "Priority Mail Innovations" }{ "value": "M6", "label": "Economy Mail Innovations" }{ "value": "M7", "label": "MaiI Innovations (MI) Returns" }{ "value": "70", "label": "UPS Access Point™ Economy" }{ "value": "71", "label": "UPS Worldwide Express Freight Midday" }{ "value": "72", "label": "UPS Worldwide Economy DDP" }{ "value": "74", "label": "UPS Express®12:00" }{ "value": "75", "label": "UPS Heavy Goods" }{ "value": "82", "label": "UPS Today Standard" }{ "value": "83", "label": "UPS Today Dedicated Courier" }{ "value": "84", "label": "UPS Today Intercity" }{ "value": "85", "label": "UPS Today Express" }{ "value": "86", "label": "UPS Today Express Saver" }{ "value": "93", "label": "Ground Saver" }{ "value": "96", "label": "UPS Worldwide Express Freight." }{ "value": "C6", "label": "Roadie XD AM (Morning delivery)" }{ "value": "C7", "label": "Roadie XD PM (Afternoon delivery)" }{ "value": "C8", "label": "Roadie XD (Anytime delivery)" }{ "value": "T0", "label": "Master" }{ "value": "T1", "label": "LTL" }`
Packaging Code	`packagingCode`	`string`	Select a value from the drop down menu:`{ "value": "01", "label": "UPS Letter" }{ "value": "02", "label": "Customer Supplied Package" }{ "value": "03", "label": "Tube" }{ "value": "04", "label": "PAK" }{ "value": "21", "label": "UPS Express Box" }{ "value": "24", "label": "UPS 25KG Box" }{ "value": "25", "label": "UPS 10KG Box" }{ "value": "30", "label": "Pallet" }{ "value": "2a", "label": "Small Express Box" }{ "value": "2b", "label": "Medium Express Box" }{ "value": "2c", "label": "Large Express Box" }{ "value": "56", "label": "Flats" }{ "value": "57", "label": "Parcels" }{ "value": "58", "label": "BPM" }{ "value": "59", "label": "First Class" }{ "value": "60", "label": "Priority" }{ "value": "61", "label": "Machineables" }{ "value": "62", "label": "Irregulars" }{ "value": "63", "label": "Parcel Post" }{ "value": "64", "label": "BPM Parcel" }{ "value": "65", "label": "Media Mail" }{ "value": "66", "label": "BPM Flat" }{ "value": "67", "label": "Standard Flat" }`
Weight Unit	`weightUnit`	`string`	Select a value from the drop down menu:`LBSKGSOZS`
Package Weight	`packageWeight`	`string`	The weight of the package

Action Authentication#

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

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

About UPS#

UPS Global Shipping and Logistics Solutions

More Ways to Connect UPS + Google Calendar#

Other Popular Integrations#

Get Tracking Info with UPS API on New Cancelled Event from Google Calendar API

Google Calendar + UPS

Create Shipment with UPS API on New Created or Updated Event (Instant) from Google Calendar API

Pipedream makes it easy to connect APIs for UPS, Google Calendar and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular