Skip to main content
The WebSocket API streams real-time monitor notifications to authenticated clients.

Authentication

Include a valid WebSocket API key in the X-Api-Key header when opening the connection. WebSocket API keys are separate from Companion API keys.

Endpoint

See the overview for connection behavior and the schema for message fields.