This API is in private preview. Target September 2026; timing is subject to change.
- Open a TLS WebSocket connection.
- Authenticate when the connection is established.
- Send one or more subscription frames.
- Wait for an acknowledgement for each subscription.
- Process messages and persist the latest cursor for each replay-capable subscription.
- If the connection closes, reconnect with exponential backoff and jitter.
- Resume replay-capable subscriptions from their last persisted cursor. Complete-snapshot streams resubscribe without a cursor.
The connection uses WebSocket ping and pong frames. Clients must respond promptly and should treat a missed pong as a dead connection, then reconnect.
For the sequencing and recovery model, see timestamps, cursors, and replay.
For replay-capable subscriptions, resume is per subscription: supply the last persisted cursor in that subscription's subscribe frame. Complete-snapshot streams resubscribe without a cursor.
Clients should apply bounded queues. A consumer that cannot keep up may receive an error frame before the connection is disconnected.
Errors arrive as a structured frame on the same connection.