gws-events-subscribe

Original🇺🇸 English
Translated

Google Workspace Events: Subscribe to Workspace events and stream them as NDJSON.

204installs
Added on

NPX Install

npx skill4agent add googleworkspace/cli gws-events-subscribe

events +subscribe

PREREQUISITE: Read
../gws-shared/SKILL.md
for auth, global flags, and security rules. If missing, run
gws generate-skills
to create it.
Subscribe to Workspace events and stream them as NDJSON

Usage

bash
gws events +subscribe

Flags

FlagRequiredDefaultDescription
--target
Workspace resource URI (e.g., //chat.googleapis.com/spaces/SPACE_ID)
--event-types
Comma-separated CloudEvents types to subscribe to
--project
GCP project ID for Pub/Sub resources
--subscription
Existing Pub/Sub subscription name (skip setup)
--max-messages
10Max messages per pull batch (default: 10)
--poll-interval
5Seconds between pulls (default: 5)
--once
Pull once and exit
--cleanup
Delete created Pub/Sub resources on exit
--no-ack
Don't auto-acknowledge messages
--output-dir
Write each event to a separate JSON file in this directory

Examples

bash
gws events +subscribe --target '//chat.googleapis.com/spaces/SPACE' --event-types 'google.workspace.chat.message.v1.created' --project my-project
gws events +subscribe --subscription projects/p/subscriptions/my-sub --once
gws events +subscribe ... --cleanup --output-dir ./events

Tips

  • Without --cleanup, Pub/Sub resources persist for reconnection.
  • Press Ctrl-C to stop gracefully.
[!CAUTION] This is a write command — confirm with the user before executing.

See Also

  • gws-shared — Global flags and auth
  • gws-events — All subscribe to google workspace events commands