# Google Calendar

Google Calendar (opens new window) is a widely-used cloud-based calendar application that enables scheduling, event tracking, reminders, and more.

Workato allows you to synchronize data with Google Calendar automatically as part of a workflow. For example, you can create events in the calendar when a meeting is scheduled in another platform or app. You can also retrieve details of calendar events and synchronize them with other tools, such as CRMs or project management platforms.

# API version

The Google Calendar connector uses the Google Calendar API v3 (opens new window).

# How to connect to Google Calendar on Workato

The Google Calendar connector offers two methods of authentication: OAuth 2.0 and Service Account.

SERVICE ACCOUNT AUTHENTICATION

The service account method allows you to authenticate your Google Calendar connection without personal user accounts. For consistent use, we suggest that you use service account authentication. Refer to the Google documentation on service account impersonation (opens new window) for more information on service account user impersonation.

Configuring Google Calendar connectionConfiguring a Google Calendar connection

# Input fields

Field Description
Connection name Assign a unique name to this Google Calendar connection to identify which Google Calendar instance it's linked to.
Authentication Type Opt for OAuth 2.0 for a user account, and Service account when using a service account to connect to Google Calendar.
GCP Project service account email (Only for service account Auth) Enter the email of your service account.
Private key (Only for service account authentication) Provide the private key of your service account.
Advanced settings (Only for service account authentication) Modify the scopes of your connection.
User email to impersonate (Only for service account Auth) Enter the email of the Google account you plan to impersonate with the service account.

# OAuth 2.0

To connect to the Google Calendar connector, sign in to your Google account.

1

Click Sign in with Google: Setup step 1

2

Sign in using your Google account. Ensure your Google account has sufficient permissions to manage all events and calendars you intend to use in Workato. Setup step 2

3

After you are signed in, you can start using the Google Calendar connector. Setup step 3

# Service account

You can authenticate to Google Calendar using a Google Cloud service account. A service account is a special type of Google account associated with your Google Cloud Project (GCP) that can be used to run API requests on your behalf. Service accounts can be used to ensure that the solution continues running even if individual users' permissions change. Read more about service accounts (opens new window).

The benefits of service accounts include the following:

  • The service account guarantees that operations continue even if the permissions of individual users change.
  • Distinct permissions enable access to only calendars shared with them.
  • Dedicated API quotas, manageable through GCP. This helps to minimize rate limit errors, with quota increments available directly from Google.

Refer to the Google service account documentation (opens new window) to learn more about service accounts.

# Enable the Google Calendar API

Access your GCP dashboard and activate the Google Calendar API in the API library (opens new window).

# Create a service account

Refer to the Google guide on setting up a new service account (opens new window) to create a service account within your GCP project. You must acquire the private key (opens new window) and download this key in JSON format after you create your service account. You can only download the key file once.

Copy the entire private key from -----BEGIN PRIVATE KEY----- to -----END PRIVATE KEY-----\n (inclusive) and paste it into the Private key field.

Configure Google Calendar SA connectionConfigure Google Calendar service account connection

# Service account permission scopes

You must have the following scopes to successfully connect to Google Calendar using a service account:

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/admin.directory.resource.calendar
  • https://www.googleapis.com/auth/tasks
  • https://www.googleapis.com/auth/userinfo.email

Refer to the Google Calendar API scopes (opens new window) documentation for a complete list of supported scopes.

# User impersonation

This allows the service account to act on behalf of the designated user, accessing and managing events in their Google Calendar. Impersonating the user ensures data accuracy and enforcement of the permissions and access controls set for that user in Google Calendar.


Last updated: 8/2/2024, 5:11:53 AM