/calendars/{calendarId}/events/watch

POST

events

Watch for changes to Events resources.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://www.googleapis.com/calendar/v3/calendars//events/watch' \
--header 'Content-Type: application/json' \
--data-raw '{
    "address": "string",
    "expiration": "string",
    "id": "string",
    "kind": "api#channel",
    "params": {
        "property1": "string",
        "property2": "string"
    },
    "payload": true,
    "resourceId": "string",
    "resourceUri": "string",
    "token": "string",
    "type": "string"
}'

Response Example

{
  "address": "string",
  "expiration": "string",
  "id": "string",
  "kind": "api#channel",
  "params": {
    "property1": "string",
    "property2": "string"
  },
  "payload": true,
  "resourceId": "string",
  "resourceUri": "string",
  "token": "string",
  "type": "string"
}

Request

Path Params

calendarId

string

required

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

Query Params

alwaysIncludeEmail

string

optional

Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).

eventTypes

array[string]

optional

Event types to return. Optional. Possible values are:

"default"

"focusTime"

"outOfOffice"This parameter can be repeated multiple times to return events of different types. Currently, this is the only allowed value for this field:

["default", "focusTime", "outOfOffice"] This value will be the default.

If you're enrolled in the Working Location developer preview program, in addition to the default value above you can also set the "workingLocation" event type:

["default", "focusTime", "outOfOffice", "workingLocation"]

["workingLocation"] Additional combinations of these 4 event types will be made available in later releases. Developer Preview.

iCalUID

string

optional

Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.

maxAttendees

integer

optional

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.

maxResults

integer

optional

Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

orderBy

string

optional

The order of the events returned in the result. Optional. The default is an unspecified, stable order.

pageToken

string

optional

Token specifying which result page to return. Optional.

privateExtendedProperty

array[string]

optional

Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.

string

optional

Free text search terms to find events that match these terms in the following fields: summary, description, location, attendee's displayName, attendee's email. Optional.

sharedExtendedProperty

array[string]

optional

Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.

showDeleted

string

optional

Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.

showHiddenInvitations

string

optional

Whether to include hidden invitations in the result. Optional. The default is False.

singleEvents

string

optional

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.

syncToken

string

optional

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. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.
There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

iCalUID

orderBy

privateExtendedProperty

sharedExtendedProperty

timeMin

timeMax

updatedMin 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.

timeMax

string

optional

Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.

timeMin

string

optional

Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.

timeZone

string

optional

Time zone used in the response. Optional. The default is the time zone of the calendar.

updatedMin

string

optional

Lower bound for an event's last modification time (as a RFC3339 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.

Body Params application/json

address

string

optional

The address where notifications are delivered for this channel.

expiration

string <int64>

optional

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

string

optional

A UUID or similar unique string that identifies this channel.

kind

string

optional

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

Default:

api#channel

params

object

optional

Additional parameters controlling delivery channel behavior. Optional.

Additional properties

string

optional

Declares a new parameter by name.

payload

boolean

optional

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

resourceId

string

optional

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

resourceUri

string

optional

A version-specific identifier for the watched resource.

token

string

optional

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

type

string

optional

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.

Examples

Responses

🟢200Successful response

application/json

Body

address

string

optional

The address where notifications are delivered for this channel.

expiration

string <int64>

optional

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

string

optional

A UUID or similar unique string that identifies this channel.

kind

string

optional

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

Default:

api#channel

params

object

optional

Additional parameters controlling delivery channel behavior. Optional.

Additional properties

string

optional

Declares a new parameter by name.

payload

boolean

optional

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

resourceId

string

optional

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

resourceUri

string

optional

A version-specific identifier for the watched resource.

token

string

optional

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

type

string

optional

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.

/calendars/{calendarId}/events/quickAdd

/calendars/{calendarId}/events/{eventId}