
Gws Events
- 25.3k installs
- 30k repo stars
- Updated July 22, 2026
- googleworkspace/cli
gws-events is a Google Workspace CLI skill that subscribes to Workspace events and streams them as structured NDJSON for developers who need real-time agent and automation workflows.
About
gws-events is a Google Workspace CLI skill for subscribing to Workspace events via the gws events API. It teaches agents to run gws events <resource> <method> with helper flows like +subscribe and +renew so Workspace notifications arrive as newline-delimited JSON suitable for parsers and webhooks. Developers reach for gws-events when building agents that react to Gmail, Drive, Calendar, or other Workspace changes without polling REST endpoints manually.
- Subscribe to Google Workspace events with a single CLI command
- Stream events as NDJSON for immediate agent consumption
- Includes helper commands: +subscribe and +renew
Gws Events by the numbers
- 25,320 all-time installs (skills.sh)
- +831 installs in the week ending Jul 28, 2026 (Skillselion tracking)
- Ranked #26 of 2,742 Automation & Workflows skills by installs in the Skillselion catalog
- Security screen: LOW risk (skills.sh audit)
- Data as of Jul 28, 2026 (Skillselion catalog sync)
gws-events capabilities & compatibility
- Works with
- google drive · gmail
- Use cases
- api development
npx skills add https://github.com/googleworkspace/cli --skill gws-eventsAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 25.3k |
|---|---|
| repo stars | ★ 30k |
| Security audit | 3 / 3 scanners passed |
| Last updated | July 22, 2026 |
| Repository | googleworkspace/cli ↗ |
How do you stream Google Workspace events as NDJSON?
Subscribe to Google Workspace events and stream them as structured NDJSON for real-time agent workflows.
Who is it for?
Backend and integration engineers wiring Google Workspace change feeds into agents, ETL jobs, or internal automation without custom polling.
Skip if: Teams that only need one-off Admin SDK REST calls or Google Workspace UI configuration without event-driven streaming.
When should I use this skill?
A developer asks to subscribe, renew, or stream Google Workspace events with the gws CLI for real-time agent workflows.
What you get
Active Workspace event subscriptions, renewed channel leases, and NDJSON event streams ready for agent or webhook consumers.
- Workspace event subscriptions
- NDJSON event stream
By the numbers
- Metadata version 0.22.5 in the gws-events skill frontmatter
- Documents events v1 API surface on the gws CLI
- Includes +subscribe and +renew helper command flows
Files
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.
Related skills
Forks & variants (1)
Gws Events has 1 known copy in the catalog totaling 6 installs. They canonicalize to this original listing.
- jetbrains - 6 installs
How it compares
Choose gws-events over generic Google API snippets when you need maintained CLI subscribe/renew flows and NDJSON streaming instead of hand-rolled polling code.
FAQ
What does gws-events output format look like?
gws-events configures the gws CLI to emit Google Workspace notifications as structured NDJSON, one JSON object per line, so agents and scripts can parse streaming change events without custom serializers.
What must be installed before using gws-events?
gws-events requires the `gws` binary on PATH and the gws-shared skill for OAuth, global flags, and security rules; run `gws generate-skills` if shared auth guidance is missing.
Which gws-events commands manage live subscriptions?
gws-events documents helper flows +subscribe to start NDJSON streams and +renew to reactivate Workspace Events channels before Google expires the subscription lease.
Is Gws Events safe to install?
skills.sh reports 3 of 3 security scanners passed. Review the Security Audits panel on this page before installing in production.