# Gws Events Subscribe

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

- Repository: https://github.com/googleworkspace/cli (32044 stars)
- Category: Engineering
- License: Apache-2.0
- Last updated: 2026-10-30
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add googleworkspace/cli --skill gws-events-subscribe -g -a claude-code -y`
Codex: `npx skills add googleworkspace/cli --skill gws-events-subscribe -g -a codex -y`
Cursor: `npx skills add googleworkspace/cli --skill gws-events-subscribe -g -a cursor -y`
Gemini CLI: `npx skills add googleworkspace/cli --skill gws-events-subscribe -g -a gemini-cli -y`

## Description

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

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# 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

| 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

```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](../gws-shared/SKILL.md), Global flags and auth
- [gws-events](../gws-events/SKILL.md), All subscribe to google workspace events commands