Skip to content

Google Calendar Integration with Orkes Conductor

Available since

  • v5.3.0 and later

Integrating Google Calendar with Orkes Conductor lets you build workflows that interact with your Google Calendar using the following operations:

  • Add Event
  • List Upcoming Events
  • Update Event
  • Update Event Time
  • Get Event
  • Check Availability
  • Delete Event

This guide explains how to set up and use the integration. Here’s an overview:

  1. Get the required credentials from Google Console.
  2. Configure a new Google Calendar integration in Orkes Conductor.
  3. Use Google Calendar integration in workflows.

Step 1: Get the Google Console credentials

To integrate Google Calendar with Orkes Conductor, retrieve the OAuth client ID and secret from the Google console, and enable the Google Calendar API.

Get OAuth Client credentials

To get the credentials:

  1. Go to the Google Cloud Console.
  2. Select your project or create a new one.
  3. In the left navigation menu, go to APIs & Services > Credentials
  4. Select + Create credentials > OAuth client ID.
  5. Choose your application type as Web application, and enter a Name.
  6. In Authorized redirect URIs, select +Add URI and enter your redirect URI in the format https://<YOUR-CONDUCTOR-CLUSTER-NAME>/integrations/oauth/callback.
  7. Select + Create.
  8. Note the generated OAuth Client ID and secret, or download and save the JSON.

Enable Google Calendar API

To enable Google Calendar API access:

  1. Go to APIs & Services > Enabled APIs & services.
  2. Select + Enable APIs and services.
  3. Search for Google Calendar API and enable it.

Step 2: Add an integration for Google Calendar

After obtaining the credentials, add a Google Calendar integration to your Conductor cluster.

To create an integration:

  1. Go to Integrations > Connected Apps from the left navigation menu on your Conductor cluster.
  2. Select + New integration.
  3. In the Productivity section, choose Google Calendar.
  4. Select + Add and enter the following parameters:
Parameter Description Required/Optional
Integration name A name for the integration. Required.
Scope The OAuth2 scope for Google Calendar API access. The scope you select determines the level of access Google grants to the integration. Supported values:
  • Read Only: Grants read-only access to calendar.
  • Read & Write: Grants full read and write access to calendar.
 Required.
OAuth Client ID The OAuth client ID generated from Step 1. Required.
OAuth Client Secret The OAuth client secret generated from Step 1. Required.
Calendar Id The default calendar ID to use. Enter primary to access the user’s primary calendar, or specify a specific calendar.
To get the calendar ID, open Google Calendar:
  • On the left sidebar, find My calendars.
  • Hover over the calendar you want.
  • Click the three dots (⋮) next to the calendar name.
  • Select Settings and sharing.
  • Scroll down to the Integrate calendar section.
  • Copy the value shown under Calendar ID.
 Required.
Description A description of the integration. Required.
  1. (Optional) Toggle the Active button off if you don't want to activate the integration instantly.
  2. Select Save.

This takes you to the Google sign-in page, where you can authorize the connection with your Google account. Once authorized, the integration is created successfully.

Step 3: Use Google Calendar integration in workflows

Once the integration is ready, this can be used directly within the workflows.

To use Google Calendar integration in a workflow:

  1. Go to Definitions > Workflow from the left navigation menu on your Conductor cluster.
  2. Select + Define workflow.
  3. In your workflow, select the (+) icon and select Connected Apps.
  4. In Add Task panel on the right, search for Google Calendar, and select the integration created in Step 2.

The following operations are available for use with this integration.

Operation Description Supported Integration Scopes
Add Event Create a new event to a Google Calendar with details including title, description, location, and time.
  • Read & Write
List Upcoming Events Retrieve a list of upcoming events from a Google Calendar within a specified time range.
  • Read & Write
  • Read Only
Update Event Update an existing event with details including title, description, location, and time.
  • Read & Write
Update Event Time Update the start and end times of an existing calendar event by its event ID.
  • Read & Write
Get Event Retrieve a calendar event by its unique event ID.
  • Read & Write
  • Read Only
Check Availability Check calendar availability for a time slot.
  • Read & Write
  • Read Only
Delete Event Delete a calendar event by its unique event ID.
  • Read & Write
  1. Select the required operation, configure the parameters, and select Save > Confirm.
  2. Select Execute to run the workflow.

For the complete operations parameters and output reference, see Google Calendar Operations Reference.