younifyd
Menu

Calendar.calendar List.watch

Watch for changes to CalendarList resources.

POST/users/me/calendarList/watch

Use it in a workflow

  1. Add a step and choose the Google Calendar connector.
  2. Pick the Calendar.calendar List.watch action (under calendarList).
  3. Fill in the fields below, then reference the result from later steps as {{calendarCalendarListWatch.response.data}}.

Request

Query parameters

altstring

Data format for the response.

One ofjson

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIpstring

Deprecated. Please use quotaUser instead.

maxResultsinteger

Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

minAccessRolestring

The minimum access role for the user in the returned entries. Optional. The default is no restriction.

One offreeBusyReaderownerreaderwriter

pageTokenstring

Token specifying which result page to return. Optional.

showDeletedboolean

Whether to include deleted calendar list entries in the result. Optional. The default is False.

showHiddenboolean

Whether to show hidden entries. Optional. The default is False.

syncTokenstring

Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

Request body

Enter the body as JSON in the step's Body field.

addressstring

The address where notifications are delivered for this channel.

expirationstring (int64)

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

idstring

A UUID or similar unique string that identifies this channel.

kindstring

Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

Default "api#channel"

paramsobject

Additional parameters controlling delivery channel behavior. Optional.

payloadboolean

A Boolean value to indicate whether payload is wanted. Optional.

resourceIdstring

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

resourceUristring

A version-specific identifier for the watched resource.

tokenstring

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

typestring

The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.

json
{
  "address": "string",
  "expiration": "string",
  "id": "string",
  "kind": "api#channel",
  "params": {},
  "payload": false,
  "resourceId": "string",
  "resourceUri": "string",
  "token": "string",
  "type": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{calendarCalendarListWatch.response.data.<field>}}.

addressstring

The address where notifications are delivered for this channel.

expirationstring (int64)

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

idstring

A UUID or similar unique string that identifies this channel.

kindstring

Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

Default "api#channel"

paramsobject

Additional parameters controlling delivery channel behavior. Optional.

payloadboolean

A Boolean value to indicate whether payload is wanted. Optional.

resourceIdstring

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

resourceUristring

A version-specific identifier for the watched resource.

tokenstring

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

typestring

The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.

json
{
  "address": "string",
  "expiration": "string",
  "id": "string",
  "kind": "api#channel",
  "params": {},
  "payload": false,
  "resourceId": "string",
  "resourceUri": "string",
  "token": "string",
  "type": "string"
}

Need more? See the Google Calendar guide for connection setup and behaviour shared by every action.