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) — request body — body
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, field body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: 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
| 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). |