gws-events-subscribeby Google

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

npx skills add https://github.com/googleworkspace/cli --skill 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

gws events +subscribe

Flags

FlagRequiredDefaultDescription
--targetWorkspace resource URI (e.g., //chat.googleapis.com/spaces/SPACE_ID)
--event-typesComma-separated CloudEvents types to subscribe to
--projectGCP project ID for Pub/Sub resources
--subscriptionExisting Pub/Sub subscription name (skip setup)
--max-messages10Max messages per pull batch (default: 10)
--poll-interval5Seconds between pulls (default: 5)
--oncePull once and exit
--cleanupDelete created Pub/Sub resources on exit
--no-ackDon't auto-acknowledge messages
--output-dirWrite each event to a separate JSON file in this directory

Examples

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