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 /v1/{name=operations/**}
Gets the latest state of a long-running operation. |
Methods |
create |
POST /v1/subscriptions
Creates a Google Workspace subscription. |
delete |
DELETE /v1/{name=subscriptions/*}
Deletes a Google Workspace subscription. |
get |
GET /v1/{name=subscriptions/*}
Gets details about a Google Workspace subscription. |
list |
GET /v1/subscriptions
Lists Google Workspace subscriptions. |
patch |
PATCH /v1/{subscription.name=subscriptions/*}
Updates or renews a Google Workspace subscription. |
reactivate |
POST /v1/{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 enables you to subscribe to events and manage change notifications for various Google Workspace applications.\u003c/p\u003e\n"],["\u003cp\u003eYou can utilize the API to create, delete, get, list, patch, and reactivate subscriptions.\u003c/p\u003e\n"],["\u003cp\u003eOperations can be monitored using the API to get their latest status.\u003c/p\u003e\n"],["\u003cp\u003eClient libraries are recommended for interacting with the service, but direct API calls are also supported using the provided service endpoint and discovery document.\u003c/p\u003e\n"]]],["The Google Workspace Events API manages change notifications via subscriptions. It provides two main REST resources: `v1.operations` and `v1.subscriptions`. `v1.operations` allows retrieving the state of long-running tasks with `get`. `v1.subscriptions` allows users to `create`, `delete`, `get`, `list`, `patch`, and `reactivate` subscriptions. Client interaction can be achieved by using Google-provided libraries or user-created ones. A discovery document and service endpoint are available for API interactions.\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\n- [REST Resource: v1.operations](#v1.operations)\n- [REST Resource: v1.subscriptions](#v1.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=v1\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: [v1.operations](/workspace/events/reference/rest/v1/operations)\n------------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------|-----------------------------------------------------------------------------------|\n| [get](/workspace/events/reference/rest/v1/operations/get) | `GET /v1/{name=operations/**}` Gets the latest state of a long-running operation. |\n\nREST Resource: [v1.subscriptions](/workspace/events/reference/rest/v1/subscriptions)\n------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|\n| [create](/workspace/events/reference/rest/v1/subscriptions/create) | `POST /v1/subscriptions` Creates a Google Workspace subscription. |\n| [delete](/workspace/events/reference/rest/v1/subscriptions/delete) | `DELETE /v1/{name=subscriptions/*}` Deletes a Google Workspace subscription. |\n| [get](/workspace/events/reference/rest/v1/subscriptions/get) | `GET /v1/{name=subscriptions/*}` Gets details about a Google Workspace subscription. |\n| [list](/workspace/events/reference/rest/v1/subscriptions/list) | `GET /v1/subscriptions` Lists Google Workspace subscriptions. |\n| [patch](/workspace/events/reference/rest/v1/subscriptions/patch) | `PATCH /v1/{subscription.name=subscriptions/*}` Updates or renews a Google Workspace subscription. |\n| [reactivate](/workspace/events/reference/rest/v1/subscriptions/reactivate) | `POST /v1/{name=subscriptions/*}:reactivate` Reactivates a suspended Google Workspace subscription. |"]]