Google Calendar Component

Manage calendars and events in Google Calendar

Component key: google-calendar

Description

Google Calendar is a time-management and scheduling calendar service developed by Google. This component allows you to create, read, update and delete events and calendars connected to your Google account.

Connections

Google Calendar OAuth 2.0

The Google Calendar component authenticates requests through Google's OAuth service. To create a Google Calendar developer account and authenticate using Google OAuth, follow the directions here Now, you will have to configure OAuth 2.0 settings in Prismatic. Create a new Google Calendar connection of type OAuth 2.0.

For Client ID and Client Secret enter the values that you got from the Google Cloud Platform auth settings.
For Scopes choose from the list found on the Google docs

Input	Default	Notes
Authorize URL string / Required Hidden Field authorizeUrl	https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&prompt=consent	The OAuth 2.0 Authorization URL for Google Calendar
Client ID string / Required clientId		Provide a string value for the client Id of your OAuth 2.0 application.
Client Secret password / Required clientSecret		Provide a string value for the client secret of your OAuth 2.0 application.
Scopes string scopes	https://www.googleapis.com/auth/calendar	A space-delimited set of one or more scopes to get the user's permission to access.
Token URL string / Required Hidden Field tokenUrl	https://oauth2.googleapis.com/token	The OAuth 2.0 Token URL for Google Calendar

Data Sources

Calendars

Get a list of available calendars | key: calendars | type: picklist

Input	Notes
Connection connection / Required connection

Example Payload for Calendars

{
  "result": [
    {
      "label": "123-456-7890",
      "key": "1234567890"
    }
  ]
}

Actions

Create Calendar

Create a new calendar | key: createCalendar

Input	Notes	Example
Description string / Required description	Provide a string value for the description.	This is an example description
Connection connection / Required googleConnection
Summary string / Required summary	Provide a string value for the summary.	This is an example summary.
Time Zone string / Required timeZone	Provide a valid value for the timezone of the event. For a complete list of timezones refer to the google docs.	America/Chicago

Create Event

Create a new event in a given calendar | key: createEvent

Input	Default	Notes	Example
Add Conference Event boolean addConferenceEvent	false	Creates a Google Meet link when set to true.
Attendees code attendees		Provide an array of attendee objects as described at https://developers.google.com/calendar/api/v3/reference/events/insert
Calendar Id string / Required calendarId		Provide a string value for the id of the calendar.	exampleId
Connection connection / Required connection
Description string / Required description		Provide a string value for the description.	This is an example description
End Time string / Required endTime		Provide a date time value for the ending time of the event.	2015-05-28T17:00:00-07:00
Event Location string / Required eventLocation		Provide a string value for the location of the event.	The Rec Center
Remind Method string remindMethod		This field is only required if useDefaultReminder is set to false.
Remind Before (minutes) string remindMinutes		This field is only required if useDefaultReminder is set to false.	30
Send Updates string sendUpdates		Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.
Start Time string / Required startTime		Provide a date time value for the starting time of the event.	2015-05-28T17:00:00-07:00
Summary string / Required summary		Provide a string value for the summary.	This is an example summary.
Time Zone string / Required timeZone		Provide a valid value for the timezone of the event. For a complete list of timezones refer to the google docs.	America/Chicago
Default Reminder boolean / Required useDefaultReminder	false	If this field is true, the event will use the default reminder settings.

Delete Calendar

Delete an existing calendar by Id | key: deleteCalendar

Input	Notes	Example
Calendar Id string / Required calendarId	Provide a string value for the id of the calendar.	exampleId
Connection connection / Required connection

Delete Event

Delete an event by an Id | key: deleteEvent

Input	Notes	Example
Calendar Id string / Required calendarId	Provide a string value for the id of the calendar.	exampleId
Connection connection / Required connection
Event Id string / Required eventId	Provide the unique identifier of the event.
Send Updates string sendUpdates	Guests who should receive notifications about the deletion of the event.

Get Calendar

Get the information and metadata of a calendar by Id | key: getCalendar

Input	Notes	Example
Calendar Id string / Required calendarId	Provide a string value for the id of the calendar.	exampleId
Connection connection / Required connection

Get Event

Get the information and metadata of an event by Id | key: getEvent

Input	Notes	Example
Calendar Id string / Required calendarId	Provide a string value for the id of the calendar.	exampleId
Connection connection / Required connection
Event Id string / Required eventId	Provide the unique identifier of the event.

List Calendars

List all calendars | key: listCalendar

Input	Notes	Example
Connection connection / Required connection
Max Results string maxResults	Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 50.	20
Page Token string pageToken	Specify the pagination token that's returned by a previous request to retrieve the next page of results	lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E

List Events

List all events in a given calendar | key: listEvents

Input	Default	Notes	Example
Calendar Id string / Required calendarId		Provide a string value for the id of the calendar.	exampleId
Connection connection / Required googleConnection
Max Attendees string maxAttendees		The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
Max Results string maxResults		Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 50.	20
Order By string orderBy		The order of the events returned in the result. Optional. The default is an unspecified, stable order.
Page Token string pageToken		Specify the pagination token that's returned by a previous request to retrieve the next page of results	lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Query string q		Free text search terms to find events that match these terms in the following fields: summary, description, location, attendee's displayName, attendee's email
Show Deleted boolean showDeleted
Show Hidden Invitations boolean showHiddenInvitations	false
Single Events boolean singleEvents		Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
Sync Token string syncToken		Specify the token for syncing the latest resources that have been modified since the last sync request	lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Time Max string timeMax		Upper bound for an event's start time to filter by. Must be a timestamp with timezone offset, 2011-06-03T10:00:00-07:00
Time Min string timeMin		Lower bound for an event's end time to filter by.
Time Zone string timeZone		Time zone used in the response. Optional.
Updated Min string updatedMin		Lower bound for an event's last modification time (as a RFC 3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.

Raw Request

Send raw HTTP request to Google Calendar | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required url		Input the path only (/colors), The base URL is already included (https://www.googleapis.com/calendar/v3). For example, to connect to https://www.googleapis.com/calendar/v3/colors, only /colors is entered in this field.	/colors
Use Exponential Backoff boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries.

Update Event

Update the information and metadata of an existing event | key: updateEvent

Input	Default	Notes	Example
Attendees code attendees		Provide an array of attendee objects as described at https://developers.google.com/calendar/api/v3/reference/events/insert
Calendar Id string / Required calendarId		Provide a string value for the id of the calendar.	exampleId
Connection connection / Required connection
Description string description		Provide a string value for the description.	This is an example description
End Time string / Required endTime		Provide a date time value for the ending time of the event.	2015-05-28T17:00:00-07:00
Event Id string / Required eventId		Provide the unique identifier of the event.
Event Location string eventLocation		Provide a string value for the location of the event.	The Rec Center
Remind Method string remindMethod		This field is only required if useDefaultReminder is set to false.
Remind Before (minutes) string remindMinutes		This field is only required if useDefaultReminder is set to false.	30
Send Updates string sendUpdates		Guests who should receive notifications about the event update (for example, title changes, etc.).
Start Time string / Required startTime		Provide a date time value for the starting time of the event.	2015-05-28T17:00:00-07:00
Summary string summary		Provide a string value for the summary.	This is an example summary.
Time Zone string / Required timeZone		Provide a valid value for the timezone of the event. For a complete list of timezones refer to the google docs.	America/Chicago
Default Reminder boolean / Required useDefaultReminder	false	If this field is true, the event will use the default reminder settings.

Manage calendars and events in Google Calendar

Description​

Connections​

Google Calendar OAuth 2.0​

Data Sources​

Calendars​

Actions​

Create Calendar​

Create Event​

Delete Calendar​

Delete Event​

Get Calendar​

Get Event​

List Calendars​

List Events​

Raw Request​

Update Event​