
Description
Subscribe to Google Workspace events.
SKILL.md
events (v1)
PREREQUISITE: Read
../gws-shared/SKILL.mdfor auth, global flags, and security rules. If missing, rungws generate-skillsto create it.
gws events <resource> <method> [flags]
Helper Commands
| Command | Description |
|---|---|
+subscribe | Subscribe to Workspace events and stream them as NDJSON |
+renew | Renew/reactivate Workspace Events subscriptions |
API Resources
message
stream— SendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.
operations
get— Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
subscriptions
create— Creates a Google Workspace subscription. To learn how to use this method, see Create a Google Workspace subscription.delete— Deletes a Google Workspace subscription. To learn how to use this method, see Delete a Google Workspace subscription.get— Gets details about a Google Workspace subscription. To learn how to use this method, see Get details about a Google Workspace subscription.list— Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions.patch— Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription.reactivate— Reactivates a suspended Google Workspace subscription. This method resets your subscription'sStatefield toACTIVE. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see Reactivate a Google Workspace subscription.
tasks
cancel— Cancel a task from the agent. If supported one should expect no more task updates for the task.get— Get the current state of a task from the agent.subscribe— TaskSubscription is a streaming call that will return a stream of task update events. This attaches the stream to an existing in process task. If the task is complete the stream will return the completed task (like GetTask) and close the stream.pushNotificationConfigs— Operations on the 'pushNotificationConfigs' resource
Discovering Commands
Before calling any API method, inspect it:
# Browse resources and methods
gws events --help
# Inspect a method's required params, types, and defaults
gws schema events.<resource>.<method>
Use gws schema output to build your --params and --json flags.
More skills from the cli repository
View all 95 skillsgws-admin-reports
generate Google Workspace audit and usage reports
Jul 12AuditGoogle WorkspaceLogsReportinggws-calendar
manage Google Calendar events and schedules
Jul 12Google CalendarGoogle WorkspaceSchedulinggws-calendar-agenda
show upcoming Google Calendar events
Jul 12Google CalendarGoogle WorkspaceMeetingsgws-calendar-insert
create Google Calendar events
Jul 12Google CalendarGoogle WorkspaceSchedulinggws-chat
manage Google Chat spaces and messages
Jul 12Google WorkspaceMessaginggws-chat-send
send messages to Google Chat spaces
Jul 12Google WorkspaceMessaging
More from Google Workspace
View publishergws-classroom
manage Google Classroom rosters and coursework
cli
Jul 12EducationGoogle Workspacegws-docs
read and write Google Docs
cli
Jul 12DocumentsGoogle DocsGoogle Workspacegws-docs-write
append text to Google Docs
cli
Jul 12DocumentsGoogle DocsGoogle WorkspaceWritinggws-drive
manage files in Google Drive
cli
Jul 12File StorageGoogle DriveGoogle Workspacegws-drive-upload
upload files to Google Drive
cli
Jul 12File StorageFile UploadsGoogle DriveGoogle Workspace