Realtime API

Real-time subscriptions and WebSocket

REST API endpoints for Realtime. 2 operations.

Create a realtime subscription

POST /api/v1/tenants/{tenant_id}/realtime/subscribe

Creates a realtime subscription for a tenant.

Auth: Bearer API key

Parameters

Responses

operationId: subscribeRealtime

Open a realtime WebSocket

GET /api/v1/tenants/{tenant_id}/realtime/ws

Upgrades the connection to a realtime WebSocket stream for a tenant.

Auth: Bearer API key

Parameters

Responses

operationId: realtimeWebsocket