Google Calendar
The Google Calendar connector enables you to automate Google Calendar operations, including creating and managing events, checking availability, and managing calendars.
Prerequisites
To use the Google Calendar connector, you first need to connect your Google account using the following steps:
- Log in to your Contentstack account.
- After logging in, click the App Switcher icon, then select Agent OS from the list.Click to enlarge
- Click + New Project or select an existing one.
- In the top navigation panel, click Automations.
- Click Configure Action Step from the left navigation panel and then Action Step to configure third-party services.
- Within the Choose Connector, click the Google Calendar connector.Click to enlarge
- Under Choose an Action, select any action (for example, Create an Event).
- In the Configure Action section, click + Add New Account to add your Google account.
- In the Manage Permissions modal, review the permission that will be granted: Full access to calendars (read, write, and delete).
- Click the Authorize button.
This sets up your Google account for the Google Calendar connector.
Set Up the Google Calendar Connector
Perform the following steps to set up the Google Calendar connector:
- From the left navigation panel, click Configure Action Step.
- Then, click Action Step to configure third-party services.
- Within the Choose Connector, click the Google Calendar connector.
- Under Choose an Action, you will see the actions grouped under Calendar and Event, described below:
Check Availability
The Check Availability action checks free and busy time slots for the selected calendars. To use the Check Availability action, follow the steps below:
- Under Choose an Action tab, select the Check Availability action.
- On the Check Availability Configure Action page, enter the details given below:
- Click + Add New Account button to connect your Google account as shown in the Prerequisites step.
- Enter comma-separated calendar IDs to check availability for in the Calendar ID field, e.g., primary, [email protected].
- Enter the start date and time for the availability check in ISO 8601 format in the Start Date/Time field, e.g., 2024-01-15T09:00:00Z.
- Enter the end date and time for the availability check in ISO 8601 format in the End Date/Time field, e.g., 2024-01-15T18:00:00Z.
- Click the Show Optional Fields toggle button to use this optional field:
- Enter the time zone to use for the query in the Time Zone field, e.g., America/New_York.Click to enlarge
- Enter the time zone to use for the query in the Time Zone field, e.g., America/New_York.
- Click Proceed.
- Check if the details are correct. If yes, then click Test Action.
- You will get the response(s). Once set, click Save and Exit.
Create a Calendar
The Create a Calendar action creates a new secondary calendar in Google Calendar. To use the Create a Calendar action, follow the steps below:
- Under Choose an Action tab, select the Create a Calendar action.
- On the Create a Calendar Configure Action page, enter the details given below:
- Click + Add New Account button to connect your Google account as shown in the Prerequisites step.
- Enter a name for the new calendar in the Calendar Name field.
- Click the Show Optional Fields toggle button to use these optional fields:
- Enter a description for the calendar in the Description field.
- Enter the default time zone for the calendar in the Time Zone field, e.g., America/New_York.
- Enter the calendar's location in the Location field.Click to enlarge
- Click Proceed.
- Check if the details are correct. If yes, then click Test Action.
- You will get the response(s). Once set, click Save and Exit.
Delete a Calendar
The Delete a Calendar action deletes a secondary calendar. You cannot delete the primary calendar. To use the Delete a Calendar action, follow the steps below:
- Under Choose an Action tab, select the Delete a Calendar action.
- On the Delete a Calendar Configure Action page, enter the details given below:
- Click + Add New Account button to connect your Google account as shown in the Prerequisites step.
- Select the calendar to delete in the Calendar Name field. You cannot delete your primary calendar.Click to enlarge
- Click Proceed.
- Check if the details are correct. If yes, then click Test Action.
- You will get the response(s). Once set, click Save and Exit.
Get Calendar
The Get Calendar action retrieves details of a specific Google Calendar. To use the Get Calendar action, follow the steps below:
- Under Choose an Action tab, select the Get Calendar action.
- On the Get Calendar Configure Action page, enter the details given below:
- Click + Add New Account button to connect your Google account as shown in the Prerequisites step.
- Select the calendar to retrieve details for in the Calendar Name field.Click to enlarge
- Click Proceed.
- Check if the details are correct. If yes, then click Test Action.
- You will get the response(s). Once set, click Save and Exit.
Create an Event
The Create an Event action creates a new event in Google Calendar. To use the Create an Event action, follow the steps below:
- Under Choose an Action tab, select the Create an Event action.
- On the Create an Event Configure Action page, enter the details given below:
- Click + Add New Account button to connect your Google account as shown in the Prerequisites step.
- Select the calendar to create the event in, in the Calendar Name field.
- Enter a title for the event in the Event Title field.
- Enter the start date and time in ISO 8601 format in the Start Date/Time field, e.g., 2024-01-15T09:00:00. For all-day events, use date format only, e.g., 2024-01-15.
- Enter the end date and time in ISO 8601 format in the End Date/Time field, e.g., 2024-01-15T10:00:00. For all-day events, use date format only, e.g., 2024-01-16.
- Click the Show Optional Fields toggle button to use these optional fields:
- Enter the time zone for the event in the Time Zone field, e.g., America/New_York. Leave empty to use the calendar's default.
- Enter the location of the event in the Location field.
- Enter comma-separated email addresses for attendees in the Attendees field.
- Enter a recurrence rule in RRULE format in the Recurrence Rule field, e.g., RRULE:FREQ=WEEKLY;COUNT=5.
- Set a reminder this many minutes before the event in the Reminder field.
- Select who can see this event from the Visibility drop-down: Default, Private, Public, and Confidential.
- Select a Color from the dropdown (Lavender, Sage, Grape, Flamingo, and Orange) or enter a color ID for the event, from 1 to 11.
Note: The Color drop-down lists named colors while the field instruction refers to a numeric ID (1–11). - Mark the All-day event checkbox to indicate whether this is an all-day event.
- Mark the Send notifications checkbox to send email notifications to attendees.Click to enlarge
- Click Proceed.
- Check if the details are correct. If yes, then click Test Action.
- You will get the response(s). Once set, click Save and Exit.
Delete an Event
The Delete an Event action deletes an event from Google Calendar. To use the Delete an Event action, follow the steps below:
- Under Choose an Action tab, select the Delete an Event action.
- On the Delete an Event Configure Action page, enter the details given below:
- Click + Add New Account button to connect your Google account as shown in the Prerequisites step.
- Select the calendar to delete the event from, in the Calendar Name field.
- Select the event name to delete in the Event Name field.
- Click the Show Optional Fields toggle button to use this optional field:
- Mark the Send notifications checkbox to send cancellation notifications to attendees.Click to enlarge
- Mark the Send notifications checkbox to send cancellation notifications to attendees.
- Click Proceed.
- Check if the details are correct. If yes, then click Test Action.
- You will get the response(s). Once set, click Save and Exit.
Find Events
The Find Events action searches and lists events from Google Calendar with optional filters. To use the Find Events action, follow the steps below:
- Under Choose an Action tab, select the Find Events action.
- On the Find Events Configure Action page, enter the details given below:
- Click + Add New Account button to connect your Google account as shown in the Prerequisites step.
- Select the calendar to search for events in, in the Calendar Name field.
- Click the Show Optional Fields toggle button to use these optional fields:
- Enter a search term to filter events in the Search Query field.
- Enter the lower bound for the event start time in ISO 8601 format in the Start Date/Time field, e.g., 2024-01-15T00:00:00Z. Defaults to the current time.
- Enter the upper bound for the event end time in ISO 8601 format in the End Date/Time field, e.g., 2024-01-31T23:59:59Z.
- Enter the maximum number of events to return in the Maximum Results field. Default is 10, maximum is 250.
- Select the order of results from the Order By drop-down: Start time, Last updated. Only works when single events are expanded.
- Mark the Expand recurring events checkbox to expand recurring events into individual instances.
- Mark the Show deleted events checkbox to include deleted events in the results.Click to enlarge
- Click Proceed.
- Check if the details are correct. If yes, then click Test Action.
- You will get the response(s). Once set, click Save and Exit.
Get an Event
The Get an Event action fetches the details of a specific event from the Google Calendar. To use the Get an Event action, follow the steps below:
- Under Choose an Action tab, select the Get an Event action.
- On the Get an Event Configure Action page, enter the details given below:
- Click + Add New Account button to connect your Google account as shown in the Prerequisites step.
- Select the calendar to fetch the event from, in the Calendar Name field.
- Select the event name to fetch its details in the Event Name field.Click to enlarge
- Click Proceed.
- Check if the details are correct. If yes, then click Test Action.
- You will get the response(s). Once set, click Save and Exit.
Quick Add Event
The Quick Add Event action creates an event from a natural language text string (e.g., "Meeting with John tomorrow at 3 PM"). To use the Quick Add Event action, follow the steps below:
- Under Choose an Action tab, select the Quick Add Event action.
- On the Quick Add Event Configure Action page, enter the details given below:
- Click + Add New Account button to connect your Google account as shown in the Prerequisites step.
- Select the calendar to create the event in, in the Calendar Name field.
- Enter the event in natural language in the Event Text field, e.g., "Meeting with John tomorrow at 3 PM" or "Dentist appointment on Friday at 2:30 PM."
- Click the Show Optional Fields toggle button to use this optional field:
- Mark the Send notifications checkbox to send email notifications to attendees.Click to enlarge
- Mark the Send notifications checkbox to send email notifications to attendees.
- Click Proceed.
- Check if the details are correct. If yes, then click Test Action.
- You will get the response(s). Once set, click Save and Exit.
Update an Event
The Update an Event action updates an existing event in Google Calendar. To use the Update an Event action, follow the steps below:
- Under Choose an Action tab, select the Update an Event action.
- On the Update an Event Configure Action page, enter the details given below:
- Click + Add New Account button to connect your Google account as shown in the Prerequisites step.
- Select the calendar containing the event in the Calendar Name field.
- Select the event to update in the Event Name field.
- Click the Show Optional Fields toggle button to use these optional fields:
- Enter a new description for the event in the Event Description field.
- Enter an updated location for the event in the Location field.
- Enter the updated start date and time, in ISO 8601 format, in the Start Date/Time field.
- Enter the updated end date and time, in ISO 8601 format, in the End Date/Time field.
- Select the updated time zone for the event from the Time Zone field.
- Enter comma-separated email addresses for attendees in the Attendees field. This replaces the existing attendee list.
- Select the updated visibility setting from the Visibility dropdown: Default, Private, Public, Confidential.
- Select the updated Color from the dropdown (Lavender, Sage, Grape, Flamingo, Orange) or enter the updated color ID for the event, from 1 to 11.
- Mark the Send notifications checkbox to send email notifications to attendees about the update.Click to enlarge
- Click Proceed.
- Check if the details are correct. If yes, then click Test Action.
- You will get the response(s). Once set, click Save and Exit.
This completes the Google Calendar connector's setup.