Google: Set up or update a push notification watch on the given user mailbox For more information, see Configure push notifications in Gmail API (https: developers google com workspace gmail api guides push)

Google gmailUsers.gmailUsersWatch: arguments, response, policy and SDK examples.

Operation google.gmail_users_watch

Provider route: POST /gmail/v1/users/{userId}/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["gmailUsers"]["gmailUsersWatch"]>[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.gmailUsers.gmailUsersWatch(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.gmail_users.gmail_users_watch(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.userId`	string	Required within parent	The user’s email address. The special value `me` can be used to indicate the authenticated user. Default: me
`query`	object	Optional	Additional keys: not allowed
`query.fields`	string	Optional	Selector specifying which fields to include in a partial response.
`query.prettyPrint`	boolean	Optional	Returns response with indentations and line breaks. Default: true
`query.quotaUser`	string	Optional	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`body`	Model	Required within parent	Expand Set up or update a push notification watch on the given user mailbox For more information, see Configure push notifications in Gmail API (https: developers google com workspace gmail api guides push) — request body — body

Referenced models: Set up or update a push notification watch on the given user mailbox For more information, see Configure push notifications in Gmail API (https: developers google com workspace gmail api guides push) — request body — body

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 Set up or update a push notification watch on the given user mailbox For more information, see Configure push notifications in Gmail API (https: developers google com workspace gmail api guides push) — response body

Schemas

Set up or update a push notification watch on the given user mailbox For more information, see Configure push notifications in Gmail API (https: developers google com workspace gmail api guides push) — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Push notification watch response.
`expiration`	string	Optional	When Gmail will stop sending notifications for mailbox updates (epoch millis). Call `watch` again before this time to renew the watch. Format: int64
`historyId`	string	Optional	The ID of the mailbox's current history record. Format: uint64

Field	Type	Presence	Description and constraints
`$`	object	Root	Set up or update a new push notification watch on this user's mailbox.
`labelFilterAction`	string	Optional	Filtering behavior of `labelIds list` specified. This field is deprecated because it caused incorrect behavior in some cases; use `label_filter_behavior` instead. One of: include, exclude
`labelFilterBehavior`	string	Optional	Filtering behavior of `labelIds list` specified. This field replaces `label_filter_action`; if set, `label_filter_action` is ignored. One of: include, exclude
`labelIds`	array	Optional	List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.
`labelIds[]`	string	Each item
`topicName`	string	Optional	A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name must already exist in Cloud Pub/Sub and you must have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic naming format). Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request).

Policy, approvals and errors

SDK function policy ID: google.gmail_users_watch. Catalog operation: gmail.users.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://mail.google.com/", "https://www.googleapis.com/auth/gmail.metadata", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly"]

Official provider source

Report an issue with this page