Skip to main content

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.

Authorization Notes#

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 credential of type OAuth 2.0 - Authorization Code.

  • 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
  • For Authorization URL enter https://accounts.google.com/o/oauth2/auth
  • For Access Token URL enter https://oauth2.googleapis.com/token

Actions#

Create Calendar#

Create a new calendar | key: createCalendar

InputKeyNotesExample

Description

string
/ Required
descriptionProvide a string value for the description.This is an example description

Summary

string
/ Required
summaryProvide a string value for the summary.This is an example summary.

Time Zone

string
/ Required
timeZoneProvide a valid value for the timezone of the event. For a complete list of timezones refer to the google docs.America/Chicago

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Event#

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

InputKeyNotesExample

Attendees

code
attendeesFor each item, provide a JavaScript Object with an email property.{"email": "someone@example.com"}

Calendar Id

string
/ Required
calendarIdProvide a string value for the id of the calendar.exampleId

Description

string
/ Required
descriptionProvide a string value for the description.This is an example description

End Time

string
/ Required
endTimeProvide a date time value for the ending time of the event.2015-05-28T17:00:00-07:00

Event Location

string
/ Required
eventLocationProvide a string value for the location of the event.The Rec Center

Remind Method

string
remindMethodThis field is only required if useDefaultReminder is set to false.

Remind Before (minutes)

string
remindMinutesThis field is only required if useDefaultReminder is set to false.30

Start Time

string
/ Required
startTimeProvide a date time value for the starting time of the event.2015-05-28T17:00:00-07:00

Summary

string
/ Required
summaryProvide a string value for the summary.This is an example summary.

Time Zone

string
/ Required
timeZoneProvide 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
useDefaultReminderIf this field is true, the event will use the default reminder settings.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Calendar#

Delete an existing calendar by Id | key: deleteCalendar

InputKeyNotesExample

Calendar Id

string
/ Required
calendarIdProvide a string value for the id of the calendar.exampleId

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Event#

Delete an event by an Id | key: deleteEvent

InputKeyNotesExample

Calendar Id

string
/ Required
calendarIdProvide a string value for the id of the calendar.exampleId

Event Id

string
/ Required
eventIdProvide the unique identifier of the event.The Rec Center

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Calendar#

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

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Event#

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

InputKeyNotesExample

Calendar Id

string
/ Required
calendarIdProvide a string value for the id of the calendar.exampleId

Event Id

string
/ Required
eventIdProvide the unique identifier of the event.The Rec Center

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Calendar#

List all calendars | key: listCalendar

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Events#

List all events in a given calendar | key: listEvents

InputKeyNotesExample

Calendar Id

string
/ Required
calendarIdProvide a string value for the id of the calendar.exampleId

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Event#

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

InputKeyNotesExample

Attendees

code
attendeesFor each item, provide a JavaScript Object with an email property.{"email": "someone@example.com"}

Calendar Id

string
/ Required
calendarIdProvide a string value for the id of the calendar.exampleId

Description

string
descriptionProvide a string value for the description.This is an example description

End Time

string
/ Required
endTimeProvide a date time value for the ending time of the event.2015-05-28T17:00:00-07:00

Event Id

string
/ Required
eventIdProvide the unique identifier of the event.The Rec Center

Event Location

string
eventLocationProvide a string value for the location of the event.The Rec Center

Remind Method

string
remindMethodThis field is only required if useDefaultReminder is set to false.

Remind Before (minutes)

string
remindMinutesThis field is only required if useDefaultReminder is set to false.30

Start Time

string
/ Required
startTimeProvide a date time value for the starting time of the event.2015-05-28T17:00:00-07:00

Summary

string
summaryProvide a string value for the summary.This is an example summary.

Time Zone

string
/ Required
timeZoneProvide 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
useDefaultReminderIf this field is true, the event will use the default reminder settings.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri