Start Planning with OptimoRoute API on New Upcoming Event Alert from Google Calendar API

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

Trigger workflow on

New Upcoming Event Alert from the Google Calendar API

Next, do this

Start Planning with the OptimoRoute 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 OptimoRoute action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Upcoming Event Alert trigger
1. Connect your Google Calendar account
2. Configure Pipedream API Key
3. Optional- Select a Calendar ID
4. Optional- Select one or more Event Types
5. Configure Minutes Before
Configure the Start Planning action
1. Connect your OptimoRoute account
2. Configure Date
3. Optional- Configure Order Numbers
4. Optional- Configure Driver Serial Numbers
5. Optional- Select a Balancing
6. Optional- Select a Balance By
7. Optional- Configure Balancing Factor
8. Optional- Select a Starts With
9. Optional- Select a Lock Type
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 Upcoming Event Alert on Google Calendar

Description:Emit new event based on a time interval before an upcoming event in the calendar.

Version:0.1.0

Key:google_calendar-upcoming-event-alert

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 googleCalendar from "../../google_calendar.app.mjs";
import taskScheduler from "../common/taskScheduler.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "google_calendar-upcoming-event-alert",
  name: "New Upcoming Event Alert",
  description: "Emit new event based on a time interval before an upcoming event in the calendar.",
  version: "0.1.0",
  type: "source",
  props: {
    googleCalendar,
    db: "$.service.db",
    http: "$.interface.http",
    pipedreamApiKey: {
      type: "string",
      label: "Pipedream API Key",
      description: "[Click here to find your Pipedream API key](https://pipedream.com/settings/user)",
      secret: true,
    },
    calendarId: {
      propDefinition: [
        googleCalendar,
        "calendarId",
      ],
    },
    eventTypes: {
      propDefinition: [
        googleCalendar,
        "eventTypes",
      ],
    },
    time: {
      type: "integer",
      label: "Minutes Before",
      description: "Number of minutes to trigger before the start of the calendar event.",
      min: 0,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.time > 0) {
      props.timer = {
        type: "$.interface.timer",
        description: "Poll the API to schedule alerts for any newly created events",
        default: {
          intervalSeconds: 60 * this.time,
        },
      };
    }
    return props;
  },
  hooks: {
    async deactivate() {
      const ids = this._getScheduledEventIds();
      if (!ids?.length) {
        return;
      }
      for (const id of ids) {
        if (await this.deleteScheduledEvent({
          body: {
            id,
          },
        }, this.pipedreamApiKey)) {
          console.log("Cancelled scheduled event");
        }
      }
      this._setScheduledEventIds();
    },
  },
  methods: {
    ...taskScheduler.methods,
    _getScheduledEventIds() {
      return this.db.get("scheduledEventIds");
    },
    _setScheduledEventIds(ids) {
      this.db.set("scheduledEventIds", ids);
    },
    _getScheduledCalendarEventIds() {
      return this.db.get("scheduledCalendarEventIds");
    },
    _setScheduledCalendarEventIds(ids) {
      this.db.set("scheduledCalendarEventIds", ids);
    },
    _hasDeployed() {
      const result = this.db.get("hasDeployed");
      this.db.set("hasDeployed", true);
      return result;
    },
    subtractMinutes(date, minutes) {
      return date.getTime() - minutes * 60000;
    },
    async getCalendarEvents() {
      const calendarEvents = [];
      const params = {
        returnOnlyData: false,
        calendarId: this.calendarId,
        eventTypes: this.eventTypes,
      };
      do {
        const {
          data: {
            items, nextPageToken,
          },
        } = await this.googleCalendar.listEvents(params);
        if (items?.length) {
          calendarEvents.push(...items);
        }
        params.pageToken = nextPageToken;
      } while (params.pageToken);
      return calendarEvents;
    },
  },
  async run(event) {
    // self subscribe only on the first time
    if (!this._hasDeployed()) {
      await this.selfSubscribe(this.pipedreamApiKey);
    }

    const scheduledEventIds = this._getScheduledEventIds() || [];

    // incoming scheduled event
    if (event.$channel === this.selfChannel()) {
      const remainingScheduledEventIds = scheduledEventIds.filter((id) => id !== event["$id"]);
      this._setScheduledEventIds(remainingScheduledEventIds);
      this.emitEvent(event, `Upcoming ${event.summary
        ? event.summary + " "
        : ""}event`);
      return;
    }

    // schedule new events
    const scheduledCalendarEventIds = this._getScheduledCalendarEventIds() || {};
    const calendarEvents = await this.getCalendarEvents();

    for (const calendarEvent of calendarEvents) {
      const startTime = calendarEvent.start
        ? (new Date(calendarEvent.start.dateTime || calendarEvent.start.date))
        : null;
      if (!startTime
        || startTime.getTime() < Date.now()
        || scheduledCalendarEventIds[calendarEvent.id])
      {
        continue;
      }
      const later = new Date(this.subtractMinutes(startTime, this.time));

      const scheduledEventId = this.emitScheduleEvent(calendarEvent, later);
      scheduledEventIds.push(scheduledEventId);
      scheduledCalendarEventIds[calendarEvent.id] = true;
    }
    this._setScheduledEventIds(scheduledEventIds);
    this._setScheduledCalendarEventIds(scheduledCalendarEventIds);
  },
  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.
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.
Pipedream API Key	`pipedreamApiKey`	`string`	Click here to find your Pipedream API key
Calendar ID	`calendarId`	`string`	Select a value from the drop down menu.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu:`defaultfocusTimeoutOfOfficeworkingLocation`
Minutes Before	`time`	`integer`	Number of minutes to trigger before the start of the calendar event.

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#

Start Planning on OptimoRoute

Description:Start planning for a given order. [See the documentation](https://optimoroute.com/api/#start-planning)

Version:0.0.1

Key:optimoroute-start-planning

View on GitHub

OptimoRoute Overview#

The OptimoRoute API offers a range of functionalities for route optimization and workforce management. By tapping into this API via Pipedream, you can automate complex logistics and delivery operations, scheduling, and real-time order tracking. Leverage the power of serverless workflows to integrate OptimoRoute with other apps, streamlining your dispatch, improving delivery times, and maximizing efficiency. Whether you're planning routes for a fleet of vehicles or scheduling service appointments, the OptimoRoute API provides the data you need to make decisions on-the-fly.

Action Code#

import optimoroute from "../../optimoroute.app.mjs";

export default {
  key: "optimoroute-start-planning",
  name: "Start Planning",
  description: "Start planning for a given order. [See the documentation](https://optimoroute.com/api/#start-planning)",
  type: "action",
  version: "0.0.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    optimoroute,
    date: {
      type: "string",
      label: "Date",
      description: "Date to be planned. YYYY-MM-DD format, for example `2013-12-20`",
    },
    orderNumbers: {
      type: "string[]",
      label: "Order Numbers",
      description: "Subset of orders on the planned date that should be included in the optimization",
      optional: true,
    },
    driverSerialNumbers: {
      type: "string[]",
      label: "Driver Serial Numbers",
      description: "Selected drivers that should be used in the optimization. By default (if useDrivers is not set or the list is empty) all available drivers for the specified date are used",
      optional: true,
    },
    balancing: {
      type: "string",
      label: "Balancing",
      description: "Route balancing settings",
      options: [
        {
          value: "OFF",
          label: "No balancing",
        },
        {
          value: "ON",
          label: "Balance routes",
        },
        {
          value: "ON_FORCE",
          label: "Balance routes and use all drivers",
        },
      ],
      optional: true,
    },
    balanceBy: {
      type: "string",
      label: "Balance By",
      description: "Balance routes by",
      options: [
        {
          value: "WT",
          label: "Working time",
        },
        {
          value: "NUM",
          label: "Number of orders per driver",
        },
      ],
      optional: true,
    },
    balancingFactor: {
      type: "string",
      label: "Balancing Factor",
      description: "Importance of balancing compared to route costs. Min: 0.0, Max: 1.0. Increasing the balancing factor will result in more balanced routes. Only applicable in combination with ON_FORCE (otherwise ignored).",
      optional: true,
    },
    startsWith: {
      type: "string",
      label: "Starts With",
      description: "Start planning from existing routes or from scratch",
      options: [
        {
          value: "EMPTY",
          label: "Ignore existing routes and start from scratch",
        },
        {
          value: "CURRENT",
          label: "Start planning with the existing routes",
        },
      ],
      optional: true,
    },
    lockType: {
      type: "string",
      label: "Lock Type",
      description: "Lock type. Applicable if startsWith is set to CURRENT",
      options: [
        {
          value: "NONE",
          label: "Allow all changes to the existing routes",
        },
        {
          value: "ROUTES",
          label: "Keep planned Routes unchanged and add new Orders to unused",
        },
        {
          value: "RESOURCES",
          label: "Keep Drivers/Vehicles for planned Orders and fit in new Orders",
        },
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.optimoroute.startPlanning({
      $,
      data: {
        date: this.date,
        balancing: this.balancing,
        balanceBy: this.balanceBy,
        balancingFactor: this.balancingFactor
          ? +this.balancingFactor
          : undefined,
        startsWith: this.startsWith,
        lockType: this.lockType,
        useDrivers: this.driverSerialNumbers
          ? this.driverSerialNumbers.map((serialNumber) => ({
            driverSerial: serialNumber,
          }))
          : undefined,
        useOrderObjects: this.orderNumbers
          ? this.orderNumbers.map((id) => ({
            orderNo: id,
          }))
          : undefined,
      },
    });
    $.export("$summary", `Successfully created planning ID: ${response.planningId}`);
    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
OptimoRoute	`optimoroute`	`app`	This component uses the OptimoRoute app.
Date	`date`	`string`	Date to be planned. YYYY-MM-DD format, for example `2013-12-20`
Order Numbers	`orderNumbers`	`string[]`	Subset of orders on the planned date that should be included in the optimization
Driver Serial Numbers	`driverSerialNumbers`	`string[]`	Selected drivers that should be used in the optimization. By default (if useDrivers is not set or the list is empty) all available drivers for the specified date are used
Balancing	`balancing`	`string`	Select a value from the drop down menu:`{ "value": "OFF", "label": "No balancing" }{ "value": "ON", "label": "Balance routes" }{ "value": "ON_FORCE", "label": "Balance routes and use all drivers" }`
Balance By	`balanceBy`	`string`	Select a value from the drop down menu:`{ "value": "WT", "label": "Working time" }{ "value": "NUM", "label": "Number of orders per driver" }`
Balancing Factor	`balancingFactor`	`string`	Importance of balancing compared to route costs. Min: 0.0, Max: 1.0. Increasing the balancing factor will result in more balanced routes. Only applicable in combination with ON_FORCE (otherwise ignored).
Starts With	`startsWith`	`string`	Select a value from the drop down menu:`{ "value": "EMPTY", "label": "Ignore existing routes and start from scratch" }{ "value": "CURRENT", "label": "Start planning with the existing routes" }`
Lock Type	`lockType`	`string`	Select a value from the drop down menu:`{ "value": "NONE", "label": "Allow all changes to the existing routes" }{ "value": "ROUTES", "label": "Keep planned Routes unchanged and add new Orders to unused" }{ "value": "RESOURCES", "label": "Keep Drivers/Vehicles for planned Orders and fit in new Orders" }`

Action Authentication#

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

About OptimoRoute#

OptimoRoute plans and optimizes routes and schedules for delivery and field service businesses.

More Ways to Connect OptimoRoute + Google Calendar#

Other Popular Integrations#

Get Mobile Events with OptimoRoute API on New Cancelled Event from Google Calendar API

Google Calendar + OptimoRoute

Start Planning with OptimoRoute API on New Upcoming Event Alert from Google Calendar API

Pipedream makes it easy to connect APIs for OptimoRoute, 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