grith.aidocs

Notifications: WebSocket

Real-time event stream for the dashboard and custom integrations.

The WebSocket channel is what powers the dashboard and grith log --tail. It's also useful as a building block for custom real-time integrations.

Connect

ws://127.0.0.1:3141/events

On connect, send a subscription message:

{ "subscribe": ["digest", "session", "audit", "notifications"] }

Or subscribe to everything:

{ "subscribe": ["*"] }

Configure (delivery via daemon)

The WebSocket isn't a delivery target in the same sense as Slack — it's a stream subscribers attach to. If you want grith to push to your custom WebSocket endpoint, use the webhook channel instead.

For consuming the daemon's built-in stream, no configuration is required beyond running grith daemon.

Event shapes

See WebSocket /events for the full event-shape reference.

Authentication

  • For v0.1: loopback only. Any local caller can subscribe.
  • For Pro/team deployments behind a reverse proxy: bearer token via Authorization header.

Reconnection

The stream is best-effort — no replay. On disconnect, reconnect with exponential backoff. Use the REST API to fetch state on (re)connect.

See also

Last updated: 2026-05-14Edit this page on GitHub →
© 2026 grith. All rights reserved.