Google: Watch for changes to Calendar List resources

← Calendar calendar list operations · Get started

Operation google.calendar_calendarlist_watch

Provider route: POST /calendar/v3/users/me/calendarList/watch. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GoogleIntegration } from "@alter-ai/google";

async function execute(input: Parameters<GoogleIntegration["calendarCalendarList"]["calendarCalendarListWatch"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.calendarCalendarList.calendarCalendarListWatch(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_google import GoogleIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.calendar_calendar_list.calendar_calendar_list_watch(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	Model	Optional	Expand Watch for changes to Calendar List resources — request body — query
body	Model	Required within parent	Expand Watch for changes to ACL resources — response body

Referenced models: Watch for changes to ACL resources — response body, Watch for changes to Calendar List resources — request body — query

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Watch for changes to ACL resources — response body

Referenced models: Watch for changes to ACL resources — response body

Schemas

Watch for changes to ACL resources — response body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	The address where notifications are delivered for this channel.
expiration	string	Optional	Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. Format: int64
id	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 keys: see wildcard field
params.*	string	Additional keys	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.

Watch for changes to Calendar List resources — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fields	string	Optional	Selector specifying which fields to include in a partial response.
prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
quotaUser	string	Optional	An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
userIp	string	Optional	Deprecated. Please use quotaUser instead.
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. Format: int32 Minimum: 1
minAccessRole	string	Optional	The minimum access role for the user in the returned entries. Optional. The default is no restriction. One of: freeBusyReader, owner, reader, writer, writerWithoutPrivateAccess
pageToken	string	Optional	Token specifying which result page to return. Optional.
showDeleted	boolean	Optional	Whether to include deleted calendar list entries in the result. Optional. The default is False.
showHidden	boolean	Optional	Whether to show hidden entries. Optional. The default is False.
showOwnOrganizationOnly	boolean	Optional	Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. 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 and showOwnOrganizationOnly query parameters 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.

Policy, approvals and errors

SDK function policy ID: google.calendar_calendarlist_watch. Catalog operation: calendar.calendarList.watch. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.calendarlist", "https://www.googleapis.com/auth/calendar.calendarlist.readonly", "https://www.googleapis.com/auth/calendar.readonly"]

Official provider source