Realtime API

Realtime API to create subscriptions and open WebSocket streams for live, per-tenant database change updates in Scalix Cloud.

REST API endpoints for Realtime. 2 operations.

Create a realtime subscription

plaintext

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

Creates a realtime subscription for a tenant.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`tenant_id`	path	`string`	Yes	Tenant id (UUID)

Responses

operationId: subscribeRealtime

plaintext

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

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

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`tenant_id`	path	`string`	Yes	Tenant id (UUID)

Responses

operationId: realtimeWebsocket