Google Calendar modules

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Topics:
Workfront Fusion

CREATED FOR:

User

In an 蜜豆视频 Workfront Fusion scenario, you can automate workflows that use Google Calendar, as well as connect it to multiple third-party applications and services.

If you need instructions on creating a scenario, see Create a scenario in 蜜豆视频 Workfront Fusion.

For information about modules, see Modules in 蜜豆视频 Workfront Fusion.

Access requirements

You must have the following access to use the functionality in this article:

蜜豆视频 Workfront plan*

Pro or higher

蜜豆视频 Workfront license*

Plan, Work

蜜豆视频 Workfront Fusion license**

Current license requirement: No Workfront Fusion license requirement.

Legacy license requirement: Workfront Fusion for Work Automation and Integration

Product

Current product requirement: If you have the Select or Prime 蜜豆视频 Workfront plan, your organization must purchase 蜜豆视频 Workfront Fusion as well as 蜜豆视频 Workfront to use functionality described in this article. Workfront Fusion is included in the Ultimate Workfront plan.

Legacy product requirement: Your organization must purchase 蜜豆视频 Workfront Fusion as well as 蜜豆视频 Workfront to use functionality described in this article.

To find out what plan, license type, or access you have, contact your Workfront administrator.

For information on 蜜豆视频 Workfront Fusion licenses, see 蜜豆视频 Workfront Fusion licenses.

Prerequisites

To use Google Calendar modules, you must have a Google account.

Google Calendar API information

The Google Calendar connector uses the following:

Base URL

https://www.googleapis.com/calendar/v3

API version

API tag

v5.4.5

Google Calendar modules and their fields

When you configure Google Calendar modules, Workfront Fusion displays the fields listed below. Along with these, additional Google Calendar fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another in 蜜豆视频 Workfront Fusion.

Events
Calendars
Access control rules
Iterators (deprecated)
Other

Watch events

This trigger module executes a scenario when a new event is added, updated, deleted, started, or ended in the calendar you specify. The module returns all standard fields associated with the record or records, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Calendar

Select the calendar you want the module to work with.

Watch Events

Choose whether you want to watch events by Created Date, Updated Date, Starting Date, or Ending Date.

Show deleted events

Enable this option to include events that were deleted.

Query

Enter text that you want to search for.

Limit

Set the maximum number of events that Workfront Fusion works with during one cycle (the number of repetitions per scenario run). If the value is set too high, the connection may be interrupted on the side of the given third-party service (timeout). Workfront Fusion has no influence on this. We recommend that you set a lower value and either define a higher value for the maximum number of cycles or run the scenario more frequently.

Search events

This action module searches for an event in the selected calendar.

You specify the calendar and the parameters of the search.

The module returns the ID of the event and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Calendar ID

Select the calendar you want to search.

Start date

Enter or map the date when the event starts. This module also retrieves events starting before this date, that are still occurring on the entered start date.

For a list of supported date and time formats, see Type coercion in 蜜豆视频 Workfront Fusion.

End date

Enter or map the date when the event ends.

For a list of supported date and time formats, see Type coercion in 蜜豆视频 Workfront Fusion.

Single events

Enable this option to treat recurring events as single instances. For example, if you have a weekly meeting and this option is enabled, the module returns each week's meeting as a separate event.

Query

Enter or map the search term that you want to search by.

Order by

Select the order of the events returned in the result.

Start Time: Order by the start date and time (ascending). This is only available when querying single events.
Updated Time: Order by last modification time (ascending).

Limit

Set the maximum number of events Workfront Fusion returns during one execution cycle.

Get an event

This action module returns the metadata for a single event in the specified calendar.

You specify the calendar and event.

The module returns the ID of the event and all associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Calendar ID

Enter or map the ID of the calendar that contains the event you want to get.

Event ID

Enter the event ID of the existing Google Calendar event that you want to get.

Create an event

This action module creates an event.

You specify the calendar and the parameters for the event.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Create an Event

Select how you would like to create the event.

In Detail

This option allows you to put in more detail about the event.
Quickly

You only need to select the calendar and enter a name for the event. You can include time and place details in the name, and Google Calendar will schedule the event for that place and time.

Calendar ID

Select the calendar where you want the event to appear.

Color

Select the color that the event shows on the calendar.

Event name

Enter or map a name for the event.

Note: If you have selected Quick add in the Create an event field, you can include the date and time of the event, and Workfront Fusion creates the event for that date and time. Example: Appointment at Capitol Hill on June 3rd 10am-10:25am. If you selected Quick add but do not include a date and time in the event name, the event is created from the current time and lasts an hour.

All day event

Enable this option if the event is an all-day event (does not require start and end times).

Start date

If this is an all-day event, enter the start date of the event.

For a list of supported date formats, see Type coercion in 蜜豆视频 Workfront Fusion.

End date

If this is an all-day event, enter the end date of the event.

For a list of supported date formats, see Type coercion in 蜜豆视频 Workfront Fusion.

Description

Enter or map a description for the event. This field supports HTML.

Location

Enter a location for the event in text form.

Use the default reminder settings for this event

Enable this option to use default reminder settings. If you set a custom reminder in the Reminder field, this value is set to No.

Reminder

Add reminder for the event. For each reminder, select the method you want to be reminded with and define how long (in minutes) before the event you want to be reminded.

Attendees

Add the attendees to the event. For each attendee, enter or map their name and email address.

Show me as

Select whether you want people who view your calendar to see you as Busy or Available during this event.

Visibility

Select the visibility of this event.

Default

The event has the visibility that you have set in your calendar settings.
Public

Anyone the calendar is shared with can see this event.
Private

Only attendees can see this event.

Send notification about the event creation

Select whether to send notifications about the creation of a new event to all guests, to non-Google Calendar guests, or to no one.

Tip: We recommend using the None option only for migration use cases.

Guests can modify the event

Enable this option if you want to guests to be able to modify this event.

Recurrence

Add any recurrence rules that you want to apply to this event. Each rule requires a list of RRULE, EXRULE, RDATE, and EXDATE lines for a recurring event. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. For more information, see .

Update an event

This action module changes an existing event.

You specify the calendar and event ID.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Calendar

Select the calendar you want to work with.

Event ID

Enter the event ID from the previously created Google Calendar event that you want to update.

You can update the event information by entering new values to the desired field. For details about the individual fields, see Create an event.

Delete an event

This action module deletes an event.

You specify the calendar and event ID.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Calendar ID

Select the calendar that contains the event you want to delete.

Event ID

Enter the event ID from a previously created Google Calendar event you want to delete.

Send notification about the event deletion

Select whether you want to send notifications about the event deletion to all guests, guests that do not use Google Calendar, or no one.

Calendars

List calendars
Get a calendar
Create a calendar
Update a calendar
Delete a calendar
Clear a calendar

List calendars

This action module returns the calendars on a user鈥檚 calendar list.

The module returns the ID of the calendar and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Minimum access role

Select the minimum access role for the user. The module returns calendars based on this minimum access role.

Free Busy Reader: The user can read free/busy information.
Owner: The user can read and modify events and can access control lists.
Reader: The user can read events that are not private.
Writer: The user can read and modify events.

Show hidden calendars

Enable this option to include hidden calendars in the list that the module returns.

Limit

Set the maximum number of calendars Workfront Fusion returns during one execution cycle.

Get a calendar

This action module retrieves a calendar.

You specify the ID of the calendar you want to retrieve.

The module returns the ID of the record and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Calendar ID

Select the calendar you want to retrieve.

Create a calendar

This action module creates a new calendar.

You specify a name for the calendar.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Calendar name

Enter a name for the new calendar.

Update a calendar

This action module updates a calendar.

You specify the ID of the calendar you want to update.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Calendar ID

Select the calendar you want to update.

Calendar name

Enter a new name for the calendar.

Delete a calendar

This action module deletes a calendar.

You specify the ID of the calendar you want to delete.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Calendar ID

Enter or map the ID聽of the calendar you want to delete.

Clear a calendar

This action module removes all events from an account鈥檚 primary calendar.

You specify the connection that connects to the account that contains the calendar you want to clear.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Access control rules

List access control rules
Get an access control rule
Create an access control rule
Update an access control rule
Delete an access control rule

List access control rules

This action module returns the rules in the access control list on a calendar.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Calendar ID

Select the calendar that contains the access control rules that you want to retrieve.

Limit

Set the maximum number of results Workfront Fusion returns during one execution cycle.

Get an access control rule

This action module returns the metadata of an access control rule.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Calendar ID

Select the calendar that contains the access control rule that you want to retrieve.

Access control rule ID

Select the access control rule you want to retrieve.

Create an access control rule

This action module creates a new access control rule.

You specify a name for the calendar.

The module returns the ID of the access control rule and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Calendar ID

Select the calendar where you want to create an access control rule.

Role

Select the role to assign to the access rule.

Free Busy Reader: The user can read free/busy information.
Owner: The user can read and modify events and can access control lists.
Reader: The user can read events that are not private.
Writer: The user can read and modify events.

Type

Select the type of scope.

Default: The public scope. This is the default value.
User: Limits the scope to a single user.
Group: Limits the scope to a group.
Domain: Limits the scope to a domain.

Note: The permissions granted to the Default, or the public, scope apply to any user, authenticated or not.

Value

Enter the email address of a user or a group, or the name of a domain, depending on the scope type.

Send notifications

Enable this option to send notifications about the access change.

Note: There are no notifications on access removal.

Update an access control rule

This action module updates an access control rule.

You specify a name for the calendar.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Calendar ID

Select the calendar that contains the access control rule you want to update.

Access control rule ID

Select the access control rule you want to update.

Role

Select the role to assign to the access rule.

None: This role provides no access.
Free Busy Reader: The user can read free/busy information.
Owner: The user can read and modify events and can access control lists.
Reader: The user can read events that are not private.
Writer: The user can read and modify events.

Send notifications

Enable this option to send notifications about the access change.

Note: There are no notifications on access removal.

Delete an access control rule

This action module deletes an access control rule.

You specify a name for the calendar.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Calendar ID

Select or map the ID聽of the calendar that contains the access control rule you want to delete.

Access control rule ID

Select or map the ID of the access control rule you want to delete.

Iterators (deprecated)

The iterate attachments and iterate attendees modules have been deprecated. To iterate attachments or attendees, use the Flow Control > Iterator module. For more information, see Iterator module in 蜜豆视频 Workfront Fusion

Other

Make an API Call
Get Free/Busy Information

Make an API Call

This module allows you to perform a custom API call.

Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods in 蜜豆视频 Workfront Fusion.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

URL

Enter a path relative to https://www.googleapis.com/calendar. Example: /v3/users/me/calendarList

Method

Headers

Add the headers of the request in the form of a standard JSON object.For example, {"Content-type":"application/json"}. Workfront Fusion adds the authorization headers for you.

Query String

Add the query for the API call in the form of a standard JSON object.

Body

Add the body content for the API call in the form of a standard JSON object.

Note:

When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.

Get Free/Busy Information

This action module returns free and busy information for a set of calendars.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Google Calendar account to Workfront Fusion, see Create a connection to 蜜豆视频 Workfront Fusion - Basic instructions

Minimum time

Enter the start of the interval that you want to retrieve information for.

For a list of supported date and time formats, see Type coercion in 蜜豆视频 Workfront Fusion.

Maximum time

Enter the end of the interval that you want to retrieve information for.

For a list of supported date and time formats, see Type coercion in 蜜豆视频 Workfront Fusion.

Calendars

For each calendar that you want to retrieve information from, click Add and enter or map the Calendar ID.

Trigger a scenario before an event

You can trigger a scenario a specified time before an event with the help of standard Google Calendar email reminders and the Webhooks >Custom mailhook module.

Use the Google Calendar >Update an event module to add an email reminder to your event:
Create a new scenario starting with the Webhooks >Custom mailhook module.
1. Copy the mailhook鈥檚 email address.
2. Save the scenario and execute it.
In Gmail, redirect the Google Calendar email reminders to the mailhook鈥檚 email address:
1. Open your Gmail settings.
2. Open the Forwarding and POP/IMAP tab.
3. Click Add a forwarding address.
4. Paste the copied mailhooks鈥檚 email address, click鈥� Next, confirm by pressing Proceed in the popup window, then click OK.
5. In Workfront Fusion, switch to the new scenario that should finish its execution by receiving the confirmation email.
6. Click the bubble above the module to inspect the module鈥檚 output.
7. Expand the Text item and copy the Confirmation code:
8. In Gmail, paste the Confirmation code in the edit box and click鈥� Verify:
9. Open the Filters and Blocked Addresses tab.
10. Click Create a new filter.
11. Setup a filter for all emails coming from calendar-notification@google.com and click鈥� Create a filter:
12. Select Forward it to and choose the mailhooks鈥檚 email address from the list.
13. Click Create filter to create the filter.
(Optional) In Workfront Fusion, add the Text parser > Match pattern module after the Webhooks >Custom mailhook module to parse the email鈥檚 HTML code to obtain any information you need.

For example, you could configure the module as follows to obtain the event鈥檚 ID:

Pattern: <meta itemprop="eventId/googleCalendar" content="(?<evenitID>.*?)"/>

Text: The HTML content item outputted from the Webhooks >Custom mailhook module.

recommendation-more-help

5f00cc6b-2202-40d6-bcd0-3ee0c2316b43