Google Workspace Events API
Stay organized with collections
Save and categorize content based on your preferences.
The Google Workspace Events API lets you subscribe to events and manage change notifications across Google Workspace applications.
Service: workspaceevents.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
https://workspaceevents.googleapis.com
| Methods |
get |
GET /v1beta/{name=operations/**}
Gets the latest state of a long-running operation. |
| Methods |
create |
POST /v1beta/subscriptions
Creates a Google Workspace subscription. |
delete |
DELETE /v1beta/{name=subscriptions/*}
Deletes a Google Workspace subscription. |
get |
GET /v1beta/{name=subscriptions/*}
Gets details about a Google Workspace subscription. |
list |
GET /v1beta/subscriptions
Lists Google Workspace subscriptions. |
patch |
PATCH /v1beta/{subscription.name=subscriptions/*}
Updates or renews a Google Workspace subscription. |
reactivate |
POST /v1beta/{name=subscriptions/*}:reactivate
Reactivates a suspended Google Workspace subscription. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-24 UTC.
[null,null,["Last updated 2025-06-24 UTC."],[[["\u003cp\u003eThe Google Workspace Events API allows you to subscribe to events and manage change notifications for various Google Workspace applications.\u003c/p\u003e\n"],["\u003cp\u003eThis API is currently in Developer Preview and offers functionalities like creating, deleting, getting, listing, updating, and reactivating subscriptions.\u003c/p\u003e\n"],["\u003cp\u003eYou can interact with the API using Google-provided client libraries or by utilizing the provided service endpoint and discovery document for custom integrations.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides access to resources such as operations (for tracking long-running tasks) and subscriptions (for managing event notifications).\u003c/p\u003e\n"],["\u003cp\u003eAll functionalities related to subscriptions within this API are part of the Google Workspace Developer Preview Program and subject to change.\u003c/p\u003e\n"]]],["The Google Workspace Events API, currently in developer preview, enables subscription to and management of change notifications across Google Workspace apps. Key actions include creating, deleting, getting, listing, patching, and reactivating subscriptions via the `v1beta.subscriptions` REST resource. The `v1beta.operations` REST resource allows getting the state of a long-running operation. The service endpoint is `https://workspaceevents.googleapis.com`, and a discovery document is provided for building client tools.\n"],null,["# Google Workspace Events API\n\nThe Google Workspace Events API lets you subscribe to events and manage change notifications across Google Workspace applications.\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](/workspace/preview), which grants early access to certain features.\n\n- [REST Resource: v1beta.operations](#v1beta.operations)\n- [REST Resource: v1beta.subscriptions](#v1beta.subscriptions)\n\nService: workspaceevents.googleapis.com\n---------------------------------------\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:\n\n- \u003chttps://workspaceevents.googleapis.com/$discovery/rest?version=v1beta\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_service_endpoint) is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:\n\n- `https://workspaceevents.googleapis.com`\n\nREST Resource: [v1beta.operations](/workspace/events/reference/rest/v1beta/operations)\n--------------------------------------------------------------------------------------\n\n| Methods ||\n|---------------------------------------------------------------|---------------------------------------------------------------------------------------|\n| [get](/workspace/events/reference/rest/v1beta/operations/get) | `GET /v1beta/{name=operations/**}` Gets the latest state of a long-running operation. |\n\nREST Resource: [v1beta.subscriptions](/workspace/events/reference/rest/v1beta/subscriptions)\n--------------------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|\n| [create](/workspace/events/reference/rest/v1beta/subscriptions/create) | `POST /v1beta/subscriptions` Creates a Google Workspace subscription. |\n| [delete](/workspace/events/reference/rest/v1beta/subscriptions/delete) | `DELETE /v1beta/{name=subscriptions/*}` Deletes a Google Workspace subscription. |\n| [get](/workspace/events/reference/rest/v1beta/subscriptions/get) | `GET /v1beta/{name=subscriptions/*}` Gets details about a Google Workspace subscription. |\n| [list](/workspace/events/reference/rest/v1beta/subscriptions/list) | `GET /v1beta/subscriptions` Lists Google Workspace subscriptions. |\n| [patch](/workspace/events/reference/rest/v1beta/subscriptions/patch) | `PATCH /v1beta/{subscription.name=subscriptions/*}` Updates or renews a Google Workspace subscription. |\n| [reactivate](/workspace/events/reference/rest/v1beta/subscriptions/reactivate) | `POST /v1beta/{name=subscriptions/*}:reactivate` Reactivates a suspended Google Workspace subscription. |"]]
