Google Calendar

The official Google Calendar integration allows your bot to access your Google Calendar data and manage events.

Setup

Basic configuration
Manual configuration

You will need:

A published bot
A Google account

In Botpress Studio, select Explore Hub in the upper-right corner.

Search for the Google Calendar integration, then select Install Integration.

In the Configuration menu, select Authorize Google Calendar.

Follow the instructions to connect Botpress to your Google account.

For more advanced use cases, you can manually configure the integration.

You will need:

Step 1: Create a Google Cloud project

Go to the Google Cloud Console and sign in with your Google account.

Go to Select a project, then select New Project.

Enter your project details:

Project name: Choose a descriptive name for your project.
Organization: Select your organization (if applicable).
Location: Choose the appropriate location.

Select Create and wait for the project to be created.

Verify you’re in the correct project by checking the project name next to the Google logo.

Step 2: Enable the Google Calendar API

In the Google Cloud Console, open the left sidebar and go to API & Services > Credentials.

Select + Create Credentials > API Key to create an API key. Copy and store it somewhere.

Go to Library, search for “Google Calendar API”, and select Enable.

Step 3: Create a service account

Open the left sidebar again and go to API & Services > Credentials.

Select + Create Credentials > Service Account.

Enter a Service account name. The Service Account ID will be automatically generated.

The remaining fields are optional. Select Done to create the service account.

Select your newly created service account, then go to the Keys tab.

Select Add Key > Create new key, choose JSON as the key type, then select Create.A JSON file will be downloaded to your machine. Keep this file secure—you’ll need it to configure the integration.

The downloaded JSON file contains sensitive credentials. Store it securely and never share it publicly. The file structure looks like this:

{
  "type": "service_account",
  "project_id": "your-project-id",
  "private_key_id": "...",
  "private_key": "...",
  "client_email": "your-service-account@your-project.iam.gserviceaccount.com",
  "client_id": "...",
  "auth_uri": "...",
  "token_uri": "...",
  "auth_provider_x509_cert_url": "...",
  "client_x509_cert_url": "...",
  "universe_domain": "googleapis.com"
}

Step 4: Enable domain-wide delegation (Google Workspace only)

Domain-wide delegation is required if you want your bot to:

Create Google Meet links for events
Send invitations to attendees
Act on behalf of users in your organization

Without domain-wide delegation, the service account can only manage its own calendar and cannot invite attendees or create Meet links.This feature is only available for Google Workspace accounts. Personal @gmail.com accounts do not support domain-wide delegation.

Follow Google’s official guide to delegate domain-wide authority to your service account.When configuring the OAuth scopes in the Google Admin Console, paste in the following scopes (comma-separated):

https://www.googleapis.com/auth/calendar,https://www.googleapis.com/auth/calendar.events

Open the left sidebar again and go to API & Services > OAuth consent screen.

Select Get started.

Configure the OAuth consent screen. Under App Information:

App name: Enter a name for your application.
User support email: Select your email address.

Then, select Next.

Under Audience, select Internal. Then, select Next.

Under Contact Information, enter a contact email address. Then, select Next.

Agree to the Google API policy, then select Create.

Step 6: Create OAuth client

Select Create OAuth client.

Select an Application type and enter a name. Then select Create.

Step 7: Configure scopes

Go to Data Access in the left sidebar, then select Add or remove scopes.

Add the following scopes:

https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events

Select Update.

Step 8: Grant calendar access to the service account

Open Google Calendar and select the settings icon in the upper-right corner. Then, select Settings.

In the left sidebar, select the calendar you want to share with your bot.

Go to Shared with > + Add people and groups.

Enter the client_email from your downloaded JSON file (for example, your-service-account@your-project.iam.gserviceaccount.com).

Set the permission to Make changes to events so the bot can manage calendar events.

Step 9: Configure the integration in Botpress

In Botpress Studio, select Explore Hub in the upper-right corner.

Search for the Google Calendar integration, then select Install Integration.

In the Configuration menu, select the drop-down and choose Configure manually.

Fill in the integration’s configuration fields:

Calendar ID

In Google Calendar, go to Settings and select your calendar.
Scroll to Integrate calendar to find your Calendar ID.
Copy the Calendar ID and paste it into the Calendar ID field in Botpress.

Client Email

Open the JSON file you downloaded in Step 3 and copy the client_email value.

Private Key

Open the JSON file you downloaded in Step 3 and copy the entire private_key value, including the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- markers.

Impersonate Email (Google Workspace only)

Enter the email address of a user in your Google Workspace that the service account will impersonate.This field is required for:

Creating Google Meet links
Sending attendee invitations

The email must belong to an actual user in your Google Workspace domain. Without this field configured, Meet creation and attendee invitations will not work.

This field only applies if you have configured domain-wide delegation. Personal @gmail.com accounts do not support impersonation.

When you’ve filled in all the fields, select Save Configuration.

You’ve successfully configured the Google Calendar integration!

Limitations

Different Google account types have different capabilities when using this integration.

Feature	Google Workspace	Personal (`@gmail.com`)
Create, read, update, delete events	Yes	Yes
Create Google Meet links	Yes	No
Invite attendees	Yes (requires domain-wide delegation)	No

Cards

Here’s a reference for all Cards available with the integration:

Check Availability

Create Event

object

Show child attributes

enum<string>

default:"confirmed"

Available options: confirmed, tentative, cancelled

enum<string>

default:"default"

Available options: default, public, private, confidential

object

Show child attributes

enum<string>

required

Available options: default, birthday, focusTime, fromGmail, outOfOffice, workingLocation

enum<string>

default:"confirmed"

Available options: confirmed, tentative, cancelled

enum<string>

default:"default"

Available options: default, public, private, confidential

array

Show array item properties

enum<string>

Available options: needsAction, declined, tentative, accepted

Delete Event

object

This Card has no output.

List Events

object

Show child attributes

array

required

Show array item properties

enum<string>

required

Available options: default, birthday, focusTime, fromGmail, outOfOffice, workingLocation

enum<string>

default:"confirmed"

Available options: confirmed, tentative, cancelled

enum<string>

default:"default"

Available options: default, public, private, confidential

array

Show array item properties

enum<string>

Available options: needsAction, declined, tentative, accepted

Update Event

object

Show child attributes

enum<string>

default:"confirmed"

Available options: confirmed, tentative, cancelled

enum<string>

default:"default"

Available options: default, public, private, confidential

object

Show child attributes

enum<string>

required

Available options: default, birthday, focusTime, fromGmail, outOfOffice, workingLocation

enum<string>

default:"confirmed"

Available options: confirmed, tentative, cancelled

enum<string>

default:"default"

Available options: default, public, private, confidential

array

Show array item properties

enum<string>

Available options: needsAction, declined, tentative, accepted

Triggers

Here’s a reference for all Triggers available with the integration:

You can access data returned from any of these Triggers by reading event.payload after the Trigger fires.

Event Created

object

Show child attributes

string

required

Event Deleted

object

Show child attributes

string

required

Event Updated

object

Show child attributes

string

required

Get started

ADK

Studio

Integrations

Webchat

Botpress Desk

Setup

Step 1: Create a Google Cloud project

Step 2: Enable the Google Calendar API

Step 3: Create a service account

Step 4: Enable domain-wide delegation (Google Workspace only)

Step 6: Create OAuth client

Step 7: Configure scopes

Step 8: Grant calendar access to the service account

Step 9: Configure the integration in Botpress

Limitations

Cards

Check Availability

Create Event

Delete Event

List Events

Update Event

Triggers

Event Created

Event Deleted

Event Updated

​Setup

​Step 1: Create a Google Cloud project

​Step 2: Enable the Google Calendar API

​Step 3: Create a service account

​Step 4: Enable domain-wide delegation (Google Workspace only)

​Step 5: Configure OAuth consent screen (if not already configured)

​Step 6: Create OAuth client

​Step 7: Configure scopes

​Step 8: Grant calendar access to the service account

​Step 9: Configure the integration in Botpress

​Limitations

​Cards

​Check Availability

​Create Event

​Delete Event

​List Events

​Update Event

​Triggers

​Event Created

​Event Deleted

​Event Updated

Setup

Step 1: Create a Google Cloud project

Step 2: Enable the Google Calendar API

Step 3: Create a service account

Step 4: Enable domain-wide delegation (Google Workspace only)

Step 5: Configure OAuth consent screen (if not already configured)

Step 6: Create OAuth client

Step 7: Configure scopes

Step 8: Grant calendar access to the service account

Step 9: Configure the integration in Botpress

Limitations

Cards

Check Availability

Create Event

Delete Event

List Events

Update Event

Triggers

Event Created

Event Deleted

Event Updated