Skip to content
Try for free
On this page

Integrations

Google Calendar

Manage Google Calendar events

Use Google Calendar to manage events and calendars, invite attendees, inspect availability, and configure sharing. Calendar event triggers can start workflows when events change.

OAuth scopes

Sim requests these scopes when someone connects a Google Calendar account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.

SettingValue
Redirect URI<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/google-calendar
Environment variablesGOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET
ScopeDescription
https://www.googleapis.com/auth/userinfo.emailView email address
https://www.googleapis.com/auth/userinfo.profileView basic profile info
https://www.googleapis.com/auth/calendarView and manage calendar

Use the block

Manage events, calendars, attendees, availability, and sharing. Event triggers can start workflows.

Actions

Google Calendar Create Event

Create a new event in Google Calendar.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoGoogle Calendar ID (e.g., primary or calendar@group.calendar.google.com)
summarystringYesEvent title/summary
descriptionstringNoEvent description
locationstringNoEvent location
startDateTimestringYesStart time. Use a datetime with timezone offset (2025-06-03T10:00:00-08:00) or a date (2025-06-03) for an all-day event
endDateTimestringYesEnd time. Use a datetime with timezone offset (2025-06-03T11:00:00-08:00) or a date (2025-06-04) for an all-day event
timeZonestringNoIANA time zone (e.g., America/Los_Angeles). Used as-is when provided. For recurring events a time zone is required to expand the recurrence correctly; for one-off events it is only needed when the datetime omits a UTC offset (a naive datetime defaults to America/Los_Angeles).
attendeesarrayNoArray of attendee email addresses
recurrencestringNoRecurrence rule(s) in RFC 5545 format (e.g., RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR). Separate multiple rules with newlines.
addGoogleMeetbooleanNoAttach a Google Meet video conference link to the event
sendUpdatesstringNoHow to send updates to attendees: all, externalOnly, or none

Output

ParameterTypeDescription
idstringEvent ID
htmlLinkstringEvent link
hangoutLinkstringGoogle Meet link
statusstringEvent status
summarystringEvent title
descriptionstringEvent description
locationstringEvent location
recurrencejsonRecurrence rules
startjsonEvent start
endjsonEvent end
attendeesjsonEvent attendees
creatorjsonEvent creator
organizerjsonEvent organizer

Google Calendar List Events

List events from Google Calendar.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoGoogle Calendar ID (e.g., primary or calendar@group.calendar.google.com)
timeMinstringNoLower bound for events (RFC3339 timestamp, e.g., 2025-06-03T00:00:00Z)
timeMaxstringNoUpper bound for events (RFC3339 timestamp, e.g., 2025-06-04T00:00:00Z)
qstringNoFree-text search across event summary, description, location, attendees, and organizer
maxResultsnumberNoMaximum number of events to return (max 2500)
pageTokenstringNoToken for retrieving the next page of results
orderBystringNoOrder of events: startTime (chronological, the default) or updated (last-modified). startTime is always valid here because singleEvents is set.

Output

ParameterTypeDescription
nextPageTokenstringNext page token
timeZonestringCalendar time zone
eventsjsonList of events

Google Calendar Get Event

Get a specific event from Google Calendar.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoGoogle Calendar ID (e.g., primary or calendar@group.calendar.google.com)
eventIdstringYesGoogle Calendar event ID to retrieve

Output

ParameterTypeDescription
idstringEvent ID
htmlLinkstringEvent link
statusstringEvent status
summarystringEvent title
descriptionstringEvent description
locationstringEvent location
startjsonEvent start
endjsonEvent end
attendeesjsonEvent attendees
creatorjsonEvent creator
organizerjsonEvent organizer

Google Calendar Update Event

Update an existing event in Google Calendar.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoGoogle Calendar ID (e.g., primary or calendar@group.calendar.google.com)
eventIdstringYesGoogle Calendar event ID to update
summarystringNoNew event title/summary
descriptionstringNoNew event description
locationstringNoNew event location
startDateTimestringNoNew start time. Use a datetime with timezone offset (2025-06-03T10:00:00-08:00) or a date (2025-06-03) for an all-day event
endDateTimestringNoNew end time. Use a datetime with timezone offset (2025-06-03T11:00:00-08:00) or a date (2025-06-04) for an all-day event
timeZonestringNoIANA time zone (e.g., America/Los_Angeles) applied to the start/end times provided in this update. Provide a new start and/or end time to change the time zone; a time zone on its own is not applied. Required for recurring events to expand the recurrence correctly.
attendeesarrayNoArray of attendee email addresses. When one or more emails are provided, they replace the existing attendee list. Leaving this empty keeps the current attendees unchanged (it does not clear them).
recurrencestringNoRecurrence rule(s) in RFC 5545 format (e.g., RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR). Separate multiple rules with newlines. When provided, replaces the event's recurrence; leaving it empty keeps the existing recurrence unchanged. Requires a timeZone for timed events.
addGoogleMeetbooleanNoAttach a Google Meet video conference link to the event
sendUpdatesstringNoHow to send updates to attendees: all, externalOnly, or none

Output

ParameterTypeDescription
idstringEvent ID
htmlLinkstringEvent link
hangoutLinkstringGoogle Meet link
statusstringEvent status
summarystringEvent title
descriptionstringEvent description
locationstringEvent location
recurrencejsonRecurrence rules
startjsonEvent start
endjsonEvent end
attendeesjsonEvent attendees
creatorjsonEvent creator
organizerjsonEvent organizer

Google Calendar Delete Event

Delete an event from Google Calendar.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoGoogle Calendar ID (e.g., primary or calendar@group.calendar.google.com)
eventIdstringYesGoogle Calendar event ID to delete
sendUpdatesstringNoHow to send updates to attendees: all, externalOnly, or none

Output

ParameterTypeDescription
eventIdstringDeleted event ID
deletedbooleanWhether deletion was successful

Google Calendar Move Event

Move an event to a different calendar.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoSource Google Calendar ID (e.g., primary or calendar@group.calendar.google.com)
eventIdstringYesGoogle Calendar event ID to move
destinationCalendarIdstringYesDestination Google Calendar ID
sendUpdatesstringNoHow to send updates to attendees: all, externalOnly, or none

Output

ParameterTypeDescription
idstringEvent ID
htmlLinkstringEvent link
statusstringEvent status
summarystringEvent title
descriptionstringEvent description
locationstringEvent location
startjsonEvent start
endjsonEvent end
attendeesjsonEvent attendees
creatorjsonEvent creator
organizerjsonEvent organizer

Google Calendar Get Instances

Get instances of a recurring event from Google Calendar.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoGoogle Calendar ID (e.g., primary or calendar@group.calendar.google.com)
eventIdstringYesRecurring event ID to get instances of
timeMinstringNoLower bound for instances (RFC3339 timestamp, e.g., 2025-06-03T00:00:00Z)
timeMaxstringNoUpper bound for instances (RFC3339 timestamp, e.g., 2025-06-04T00:00:00Z)
maxResultsnumberNoMaximum number of instances to return (default 250, max 2500)
pageTokenstringNoToken for retrieving subsequent pages of results

Output

ParameterTypeDescription
nextPageTokenstringNext page token
timeZonestringCalendar time zone
instancesjsonList of recurring event instances

Google Calendar List Calendars

List all calendars in the user's calendar list.

Inputs and outputs

Input

ParameterTypeRequiredDescription
minAccessRolestringNoMinimum access role for returned calendars: freeBusyReader, reader, writer, or owner
maxResultsnumberNoMaximum number of calendars to return (default 100, max 250)
pageTokenstringNoToken for retrieving subsequent pages of results

Output

ParameterTypeDescription
nextPageTokenstringNext page token
calendarsarrayList of calendars
↳ idstringCalendar ID
↳ summarystringCalendar title
↳ descriptionstringCalendar description
↳ locationstringCalendar location
↳ timeZonestringCalendar time zone
↳ accessRolestringAccess role for the calendar
↳ backgroundColorstringCalendar background color
↳ foregroundColorstringCalendar foreground color
↳ primarybooleanWhether this is the primary calendar
↳ hiddenbooleanWhether the calendar is hidden
↳ selectedbooleanWhether the calendar is selected

Google Calendar Quick Add

Create events from natural language text.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoGoogle Calendar ID (e.g., primary or calendar@group.calendar.google.com)
textstringYesNatural language text describing the event (e.g., "Meeting with John tomorrow at 3pm")
attendeesarrayNoArray of attendee email addresses (comma-separated string also accepted)
sendUpdatesstringNoHow to send updates to attendees: all, externalOnly, or none

Output

ParameterTypeDescription
idstringEvent ID
htmlLinkstringEvent link
statusstringEvent status
summarystringEvent title
descriptionstringEvent description
locationstringEvent location
startjsonEvent start
endjsonEvent end
attendeesjsonEvent attendees
creatorjsonEvent creator
organizerjsonEvent organizer

Google Calendar Invite Attendees

Invite attendees to an existing Google Calendar event.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoGoogle Calendar ID (e.g., primary or calendar@group.calendar.google.com)
eventIdstringYesGoogle Calendar event ID to invite attendees to
attendeesarrayYesArray of attendee email addresses to invite
sendUpdatesstringNoHow to send updates to attendees: all, externalOnly, or none (defaults to all)
replaceExistingbooleanNoWhether to replace existing attendees or add to them (defaults to false)

Output

ParameterTypeDescription
idstringEvent ID
htmlLinkstringEvent link
statusstringEvent status
summarystringEvent title
descriptionstringEvent description
locationstringEvent location
startjsonEvent start
endjsonEvent end
attendeesjsonEvent attendees
creatorjsonEvent creator
organizerjsonEvent organizer

Google Calendar Respond to Invitation

RSVP to a Google Calendar event (accept, decline, or tentative) as the connected account. Only your own response changes; other guests are left untouched.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoGoogle Calendar ID the invitation appears on (e.g., primary or calendar@group.calendar.google.com)
eventIdstringYesGoogle Calendar event ID to respond to. Use a recurring-event instance ID (as returned by List Events or Get Recurring Instances) to respond to a single occurrence; the series ID responds to every occurrence.
responseStatusstringYesYour response: accepted, declined, or tentative
commentstringNoOptional note to include with your response
sendUpdatesstringNoWho to notify about your response: all, externalOnly, or none

Output

ParameterTypeDescription
idstringEvent ID
htmlLinkstringEvent link
statusstringEvent status
summarystringEvent title
startjsonEvent start
endjsonEvent end
responseStatusstringYour confirmed response (accepted, declined, or tentative)
commentstringYour response comment
attendeesjsonEvent attendees
organizerjsonEvent organizer

Google Calendar Free/Busy

Query free/busy information for one or more Google Calendars.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdsstringYesComma-separated calendar IDs to query (e.g., "primary,other@example.com")
timeMinstringYesStart of the time range (RFC3339 timestamp, e.g., 2025-06-03T00:00:00Z)
timeMaxstringYesEnd of the time range (RFC3339 timestamp, e.g., 2025-06-04T00:00:00Z)
timeZonestringNoIANA time zone (e.g., "UTC", "America/New_York"). Defaults to UTC.

Output

ParameterTypeDescription
timeMinstringStart of the queried time range
timeMaxstringEnd of the queried time range
calendarsjsonPer-calendar free/busy data with busy periods and any errors

Google Calendar Create Calendar

Create a new secondary calendar.

Inputs and outputs

Input

ParameterTypeRequiredDescription
summarystringYesTitle of the new calendar
descriptionstringNoDescription of the new calendar
locationstringNoGeographic location of the calendar as free-form text
timeZonestringNoTime zone of the calendar as an IANA name (e.g., America/Los_Angeles)

Output

ParameterTypeDescription
idstringCalendar ID
summarystringCalendar title
descriptionstringCalendar description
locationstringCalendar location
timeZonestringCalendar time zone

Google Calendar Update Calendar

Update a secondary calendar's metadata.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoCalendar ID to update (e.g., primary or calendar@group.calendar.google.com)
summarystringNoNew title for the calendar
descriptionstringNoNew description for the calendar
locationstringNoNew geographic location of the calendar as free-form text
timeZonestringNoNew time zone of the calendar as an IANA name (e.g., America/Los_Angeles)

Output

ParameterTypeDescription
idstringCalendar ID
summarystringCalendar title
descriptionstringCalendar description
locationstringCalendar location
timeZonestringCalendar time zone

Google Calendar Delete Calendar

Permanently delete a secondary calendar.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringYesSecondary calendar ID to delete (e.g., calendar@group.calendar.google.com). The primary calendar cannot be deleted.

Output

ParameterTypeDescription
calendarIdstringDeleted calendar ID
deletedbooleanWhether deletion was successful

Google Calendar Share Calendar

Grant a user, group, or domain access to a calendar.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoCalendar ID to share (e.g., primary or calendar@group.calendar.google.com)
rolestringYesAccess role to grant: freeBusyReader, reader, writer, or owner
scopeTypestringYesType of grantee: user, group, domain, or default (public)
scopeValuestringNoEmail (user/group), domain name (domain), or empty for default. Required unless scope type is default.
sendNotificationsbooleanNoWhether to send a notification email about the change. Defaults to true.

Output

ParameterTypeDescription
idstringACL rule ID
rolestringGranted access role
scopejsonGrantee scope (type and value)

Google Calendar Update Sharing

Change the access role granted by an existing calendar sharing (ACL) rule.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoCalendar ID to modify (e.g., primary or calendar@group.calendar.google.com)
ruleIdstringYesACL rule ID to update (e.g., user:person@example.com)
rolestringYesNew access role to grant: freeBusyReader, reader, writer, or owner
sendNotificationsbooleanNoWhether to send a notification email about the change. Defaults to true.

Output

ParameterTypeDescription
idstringACL rule ID
rolestringGranted access role
scopejsonGrantee scope (type and value)

Google Calendar List Sharing

List the access control rules (sharing) for a calendar.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoCalendar ID to inspect (e.g., primary or calendar@group.calendar.google.com)
maxResultsnumberNoMaximum number of ACL rules to return
pageTokenstringNoToken for retrieving subsequent pages of results
showDeletedbooleanNoInclude deleted ACL rules (with role "none")

Output

ParameterTypeDescription
nextPageTokenstringNext page token
rulesarrayList of ACL rules
↳ idstringACL rule ID
↳ rolestringAccess role
↳ scopejsonGrantee scope (type and value)

Google Calendar Remove Sharing

Revoke an access control rule (sharing) from a calendar.

Inputs and outputs

Input

ParameterTypeRequiredDescription
calendarIdstringNoCalendar ID to modify (e.g., primary or calendar@group.calendar.google.com)
ruleIdstringYesACL rule ID to remove (e.g., user:person@example.com)

Output

ParameterTypeDescription
ruleIdstringRemoved ACL rule ID
deletedbooleanWhether removal was successful

Triggers

A trigger starts a workflow when a supported event occurs in this service.

These triggers poll for new data on a schedule.

Google Calendar Event Trigger

Triggers when events are created, updated, or cancelled in Google Calendar

Configuration and outputs

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesConnect your Google account to access Google Calendar.
calendarIdfile-selectorNoThe calendar to monitor for event changes.
manualCalendarIdstringNoThe calendar to monitor for event changes.
eventTypeFilterstringNoOnly trigger for specific event types. Defaults to all events.
searchTermstringNoOptional: Filter events by text match across title, description, location, and attendees.

Output

ParameterTypeDescription
eventobject
↳ idstringCalendar event ID
↳ statusstringEvent status (confirmed, tentative, cancelled)
↳ eventTypestringChange type: "created", "updated", or "cancelled"
↳ summarystringEvent title
↳ eventDescriptionstringEvent description
↳ locationstringEvent location
↳ htmlLinkstringLink to event in Google Calendar
↳ startjsonEvent start time
↳ endjsonEvent end time
↳ createdstringEvent creation time
↳ updatedstringEvent last updated time
↳ attendeesjsonEvent attendees
↳ creatorjsonEvent creator
↳ organizerjsonEvent organizer
calendarIdstringCalendar ID
timestampstringEvent processing timestamp in ISO format
Was this helpful?
Suggest an edit