/users/me/calendarList/watch

POST

calendarList

Watch for changes to CalendarList resources.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://www.googleapis.com/calendar/v3/users/me/calendarList/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

Query Params

maxResults

integer

optional

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.

minAccessRole

string

optional

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

pageToken

string

optional

Token specifying which result page to return. Optional.

showDeleted

string

optional

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

showHidden

string

optional

Whether to show hidden entries. 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. 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.

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.

Modified at 2023-08-15 05:59:47

/users/me/calendarList

/users/me/calendarList/{calendarId}