Unify Integrations
Logo
Google Calendar

Google Calendar

Logo

7 mins READ

Google Calendar is Google's cloud-based calendar service for scheduling events, setting reminders and sharing calendars. The UnifyApps Google Calendar connector uses the Google Calendar API to create, update and delete events and calendars, manage attendees, check free-busy times, list and search events, and react to event changes from workflows and agents. It also creates and updates Google Tasks and downloads event attachments from Google Drive.

This guide covers every authentication type available on the connection form, and the actions and triggers supported, along with the Google scope each one needs.

Authentication

Before you begin, you should have the following information:

  • Connection name: a descriptive name such as MyAppGoogleCalendarIntegration, so the connection is easy to identify later.

  • Authentication type: select the type of authentication for connecting to your Google Calendar account:

    1. OAuth

    2. OAuth with Client Credentials

    3. Service Account

The OAuth and OAuth with Client Credentials types have a Scopes field. By default it selects every scope the connector offers: calendar, calendar.readonly, calendar.events, calendar.events.readonly, tasks, tasks.readonly, drive.readonly, userinfo.email and userinfo.profile, which together cover every action below. Choose narrower scopes only if you know which actions the connection will run; see the Scopes Required column in the tables below.

1. OAuth

Use this when you want to connect with your own Google account and do not need to create a Google Cloud app.

  1. Enter a Connection name.

  2. Select OAuth as the Authentication type.

  3. Keep the default Scopes, or select the scopes you need.

  4. Click Authorize. You are redirected to the Google sign-in page.

  5. Sign in with the Google account whose calendars the connection should use.

  6. Review the permissions on the consent screen, for example View and edit events on all your calendars, and click Allow.

  7. You are redirected back to UnifyApps with a confirmation that the account is connected.

google-calendar-screenshot-1.png
google-calendar-screenshot-1.png

2. OAuth with Client Credentials

Use this when your organization wants the connection to use its own Google Cloud OAuth client, while actions still run as the Google user who signs in.

Step 1: Create an OAuth client in Google Cloud

  1. In the Google Cloud Console, select or create a project, and enable the Google Calendar API under APIs & Services → Library. Also enable the Google Tasks API if you will use the task actions, and the Google Drive API if you will download event attachments.

  2. Go to Google Auth platform → Branding. If you see Google Auth platform not configured yet, click Get Started, enter an App name, User support email, Audience and contact email, and click Create.

  3. Go to Data Access, click Add or Remove Scopes, select the Calendar (and, if needed, Tasks and Drive) scopes the connection will use, and click Save. If the audience is External, add the users who will sign in under Audience → Test users.

  4. Go to Google Auth platform → Clients and click Create Client. Choose Web application as the Application type and enter a name.

  5. Under Authorized redirect URIs, click Add URI and paste the Callback URL shown on the UnifyApps connection form (it is copyable and differs per environment).

  6. Click Create, then copy the Client ID and Client secret. Copy the secret immediately: Google shows it only once.

Step 2: Connection setup in UnifyApps

  1. Open Connections → New Connection → Google Calendar and enter a Connection name.

  2. Select OAuth with Client Credentials as the Authentication type.

  3. Enter the Client ID and Client Secret copied from Google Cloud.

  4. Select the same Scopes you added to the consent screen.

  5. Click Authorize, sign in with Google and click Allow on the consent screen.

  6. Confirm the success message after the redirect back to UnifyApps.

3. Service Account

Use this for Google Workspace domains, where a service account acts on behalf of a user in the domain through domain-wide delegation. No user has to sign in.

Step 1: Create a service account in Google Cloud

  1. In the Google Cloud Console, select or create a project, and enable the Google Calendar API under APIs & Services → Library. Also enable the Google Tasks API and Google Drive API if you will use the task actions or download event attachments.

  2. Go to IAM & Admin → Service Accounts and click Create service account. Enter a name and click Done.

  3. Open the service account and copy its Email. Click Show advanced settings and, under Domain-wide delegation, copy the Client ID used in the next step.

  4. Go to the Keys tab → Add key → Create new key, choose JSON and click Create. The downloaded file holds the client_email and private_key. Store it securely.

google-calendar-screenshot-2.png
google-calendar-screenshot-2.png

Step 2: Give the service account domain-wide access

  1. A Google Workspace super administrator opens the Admin console → Security → Access and data control → API controls.

  2. Click Manage Domain Wide Delegation → Add new.

  3. Enter the service account's client ID and add these four OAuth scopes, separated by commas, then click Authorize: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.events, https://www.googleapis.com/auth/tasks and https://www.googleapis.com/auth/drive.readonly. See Delegate domain-wide authority to your service account for details.

Note: this authentication type has no Scopes field. The connection always requests the four scopes above, so all four must be authorized for domain-wide delegation, or Google refuses to issue a token. The connection can only reach the calendars of users in the Workspace domain where delegation was granted. Google says changes can take up to 24 hours to apply.

Step 3: Create the connection in UnifyApps

  1. Select Service Account as the Authentication type.

  2. Enter the GCP Project Service Account Email and paste the Private Key from the JSON key file.

  3. Enter the User email of the Workspace user whose calendars the connection acts on.

  4. Click Test Connection to validate the credentials, then click Create.

Actions

Scopes are shown in short form: calendar.events means https://www.googleapis.com/auth/calendar.events. Only scopes offered in the connection form's Scopes list are shown; any broader scope also works, and calendar covers every calendar action.

Actions

Description

Scopes Required

Adds attendees to event

Adds a list of attendees to an event in Google Calendar.

calendar.events (or calendar)

Create all day event

Creates an all-day event in Google Calendar.

calendar.events (or calendar)

Create calendar

Creates a calendar in Google Calendar.

calendar

Create event

Creates a new event in Google Calendar.

calendar.events (or calendar)

Create task

Creates a task in a task list in Google Calendar.

tasks

Delete attendees from an event

Removes a list of attendees from an event in Google Calendar.

calendar.events (or calendar)

Delete event

Deletes an event by its event ID in Google Calendar.

calendar.events (or calendar)

Download file attachments

Downloads the file attachments of an event in Google Calendar from Google Drive.

drive.readonly

Free-Busy times

Checks free-busy times in Google Calendar.

calendar.readonly (or calendar)

Get calendar by ID

Gets a calendar by its ID from Google Calendar.

calendar.readonly (or calendar)

Get calendar permissions

Gets the access control rules (sharing permissions) of a calendar in Google Calendar.

calendar

Get event by ID

Gets an event by its ID from Google Calendar.

calendar.events.readonly (or calendar.readonly)

List calendars

Lists the calendars in Google Calendar.

calendar.readonly (or calendar)

List events

Lists the events in a specific calendar in Google Calendar.

calendar.events.readonly (or calendar.readonly)

List instances

Lists the instances of a recurring event in Google Calendar.

calendar.events.readonly (or calendar.readonly)

List meetings

Lists meetings in Google Calendar.

calendar.events.readonly (or calendar.readonly)

Search events

Searches for events in a specific calendar by any search term.

calendar.events.readonly (or calendar.readonly)

Update event

Updates an event in Google Calendar.

calendar.events (or calendar)

Update task

Updates a task in Google Calendar.

tasks

Watch calendar events

Starts a watch that sends real-time notifications to a webhook when events are created, updated or deleted in Google Calendar.

calendar.events.readonly (or calendar.readonly)

Delete calendar

Deletes a calendar in Google Calendar.

calendar

Get event attendees

Gets the attendee list of an event in Google Calendar.

calendar.events.readonly (or calendar.readonly)

Update calendar

Updates calendar properties (name, description, color) in Google Calendar.

calendar

Update task list

Updates a task list in Google Calendar.

tasks

Triggers

Triggers

Description

Scopes Required

Event changed (Google Calendar)

Triggers when an event is created or updated in Google Calendar.

calendar.events.readonly (or calendar.readonly)