73ai/gws-events

events (v1)

PREREQUISITE: Read ../gws-shared/SKILL.md for auth, global flags, and security rules. If missing, run gws generate-skills to 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. Required: name (string) Example: gws events operations get --params '{"name":"..."}'

subscriptions

• create — Creates a Google Workspace subscription. To learn how to use this method, see Create a Google Workspace subscription. Key params: validateOnly (boolean) Example: gws events subscriptions create --params '{"validateOnly":"..."}'
• delete — Deletes a Google Workspace subscription. To learn how to use this method, see Delete a Google Workspace subscription. Required: name (string) Key params: allowMissing (boolean), etag (string), validateOnly (boolean) Example: gws events subscriptions delete --params '{"name":"..."}'
• get — Gets details about a Google Workspace subscription. To learn how to use this method, see Get details about a Google Workspace subscription. Required: name (string) Example: gws events subscriptions get --params '{"name":"..."}'
• list — Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions. Key params: filter (string), pageSize (int32), pageToken (string) Example: gws events subscriptions list --params '{"filter":"...","pageSize":"..."}'
• patch — Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription. Required: name (string) Key params: updateMask (google-fieldmask), validateOnly (boolean) Example: gws events subscriptions patch --params '{"name":"..."}'
• reactivate — Reactivates a suspended Google Workspace subscription. This method resets your subscription's State field to ACTIVE. 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. Required: name (string) Example: gws events subscriptions reactivate --params '{"name":"..."}'

tasks

• cancel — Cancel a task from the agent. If supported one should expect no more task updates for the task. Required: name (string) Example: gws events tasks cancel --params '{"name":"..."}'
• get — Get the current state of a task from the agent. Required: name (string) Key params: historyLength (int32), tenant (string) Example: gws events tasks get --params '{"name":"..."}'
• 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. Required: name (string) Key params: tenant (string) Example: gws events tasks subscribe --params '{"name":"..."}'
• 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.