Google Calendar
This page provides an overview of the Google Calendar connection, which enables you to retrieve information from a connected Google Calendar.
This page outlines the following aspects of the Google Calendar connection:
The only configuration requirements for the Google Calendar connection are:
- Connection Name: Name of your connection. This appears as a title for your connection tile in the Connect tab.
- Authenticate: Opens an authentication window for you to sign into your Google Calendar.
The Google Calendar connection enables you to add the following actions to the connection:
The
getMyUserSettings
action retrieves the Google Calendar account's user settings. Its only configurable parameter is Action Name, which determines the component's name in your component library.The
listMyCalendars
action retrieves a list of calendars within the connected Google Calendar account. Its only configurable parameter is Action Name, which determines the component's name in your component library.The
getFreeBusyCalendar
action enables you to retrieve the Google Calendar's private event schedule from a selected date range. The following table outlines its parameters:Parameter | Type | Description |
---|---|---|
Action Name | string | Name of the custom component action. Determines the component's name in your component library. |
minDate | string | Earliest date from when you want to retrieve events. Dates are written in ISO format. |
maxDate | string | Latest date from when you want to retrieve events. Dates are written in ISO format. |
The
getEvents
action retrieves all events from the connected calendar. The following table outlines its parameters:Parameter | Type | Description |
---|---|---|
Action Name | string | Name of the custom component action. Determines the component's name in your component library. |
calendarId | string | ID of the calendar with the events you want to retrieve. |
The
getEventsForDateRange
action enables you to retrieve all the events from a connected calendar from within a selected date range. The following table outlines its parameters:Parameter | Type | Description |
---|---|---|
Action Name | string | Name of the custom component action. Determines the component's name in your component library. |
calendarId | string | ID of the calendar with the events you want to retrieve. |
The
addEvent
action enables you to add a new event to the connected calendar from Uiflow. The following table outlines its parameters:Parameter | Type | Description |
---|---|---|
Action Name | string | Name of the custom component action. Determines the component's name in your component library. |
summary | string | Headline of the event you want to add. |
description | string | Description of the event you want to add. |
startDateTime | string | Date and time the event starts. Dates and times are written in ISO format. |
endDateTime | string | Date and time the event ends. Dates and times are written in ISO format. |
The
changeEvent
action enables you to change an event in the connected calendar. The following table outlines its parameters:Parameter | Type | Description |
---|---|---|
Action Name | string | Name of the custom component action. Determines the component's name in your component library. |
calendarId | string | ID of the calendar with the event you want to change. |
eventId | string | ID of the event you want to change. |
summary | string | New headline for the event you want to change. |
description | string | New description for the event you want to change. |
startDateTime | string | New starting date and time of the event. Dates and times are written in ISO format. |
endDateTime | string | New ending date and time of the event. Dates and times are written in ISO format. |
The
deleteEvent
action enables you to delete events from the connected calendar. The following table outlines its parameters:Parameter | Type | Description |
---|---|---|
Action Name | string | Name of the custom component action. Determines the component's name in your component library. |
calendarId | string | ID of the calendar with the event you want to delete. |
eventId | string | ID of the event you want to delete. |
The
addEventWithAttendees
action enables you to create a new Google Calendar event with attendees. The following table outlines its parameters:Parameter | Type | Description |
---|---|---|
Action Name | string | Name of the custom component action. Determines the component's name in your component library. |
calendarId | string | ID of the calendar where you want to add the event. |
sendUpdatesTo | string | Recipients of event update notifications. |
summary | string | Headline of the event you want to add. |
description | string | Description of the event you want to add. |
attendees | array | Array of objects containing attendee information (e.g., names, emails, phone numbers, etc.). |
startDateTime | string | Start date and time of the event. Dates and times are written in ISO format. |
endDateTime | string | End date and time of the event. Dates and times are written in ISO format. |
The component preview shows how your connection component appears in the Logic view of your Uiflow application.
This section outlines how to:

To change the component name, navigate to the Edit Action section and adjust the Action Name field.

To display parameters on your connection component, click Expose above the parameter fields. Any selected parameters appear as nodes on the left side of the connection component.

Last modified 20d ago