Web Socket connections should only be used to monitor and manage resources that are changing often, and where live-updating the UI in response to these changes is important. This makes the connection perfect for monitoring transcode tasks and media ingestion.
The server will send messages to connected clients when certain resources change. For small resources, the entire DTO will be provided (the same DTO as you’d receive from a GET request via the REST API). However for larger items, especially those containing nested relational data, only ids will be provided.
Each message will contain:
| Field Name | Type | Description | Required? |
|---|---|---|---|
title |
string |
The title of the message | Yes |
arguments |
Object |
The payload of the message | No |
The resources which the server will send updates for, along with when and what information, can be found below.