Workspace Event Subscription

v20260401

gws-events-subscribe

CLI skill that lets you subscribe to Google Workspace events, pull them via Pub/Sub, and stream each payload as NDJSON with options for batching, cleanup, and file output.

Google Workspace Events Subscription CLI NDJSON Pub/Sub Streaming

Get Skill

273 downloads

Overview

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

Flag	Required	Default	Description
`--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`	—	10	Max messages per pull batch (default: 10)
`--poll-interval`	—	5	Seconds 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

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.