Voltar ao índice
Ferramentas e automação Fonte oficial

Assinar eventos do Workspace em NDJSON

Cria ou usa uma assinatura Pub/Sub para receber eventos do Google Workspace e transmiti-los como NDJSON.

Ver código no GitHub Instala diretamente do repositório-fonte.

O que esta skill faz

gws-events-subscribe conecta um recurso do Workspace a eventos selecionados e consome mensagens via Pub/Sub. O fluxo permite controlar lote, intervalo, confirmação, execução única, limpeza e gravação em arquivos JSON.

Quando usar

  • Acompanhar novos eventos de um espaço do Google Chat
  • Consumir uma assinatura Pub/Sub já existente
  • Salvar cada evento recebido em um arquivo JSON
  • Executar uma única coleta para diagnóstico

Como usar

  1. Leia gws-shared e configure autenticação e segurança
  2. Defina target, event-types e projeto ou informe uma subscription
  3. Revise opções de ack, cleanup, lote e intervalo
  4. Execute o stream e encerre com Ctrl-C quando necessário

O que revisar antes de instalar

  • Recursos Pub/Sub persistem se --cleanup não for usado
  • --no-ack pode causar nova entrega de mensagens
  • O acesso depende das permissões no Workspace e no projeto GCP

SKILL.md

---
name: gws-events-subscribe
description: "Google Workspace Events: Subscribe to Workspace events and stream them as NDJSON."
metadata:
  version: 0.22.5
  openclaw:
    category: "productivity"
    requires:
      bins:
        - gws
    cliHelp: "gws events +subscribe --help"
---

# 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