Event API
This page documents how to subscribe to WebSocket events from the device and what the responses will look like.
Resources
The following API resources are available for download:
AyncAPI
HTML Demo
Subscribing to Events
The device supports WebSocket connections for event notifications.
WebSocket URL:
wss://{DEVICE_IP}/api/events
Protocol: wss (WebSocket Secure)
To connect to this WebSocket endpoint, use any WebSocket-capable client that supports JSON payloads.
Listening to Events
Once connected, you will begin receiving messages when events occur. Below are the possible event types and the schema of their responses.
Event Types and Payloads
ConfigurationModeUpdated
Triggered when the configuration mode of the device changes.
{
"type": "ConfigurationModeUpdated",
"configurationMode": "Managed"
}
CurrentPresetChanged
Triggered when the currently selected preset is changed.
{
"type": "CurrentPresetChanged",
"presetId": 1
}
GfxResolutionChanged
Triggered when the graphics resolution changes.
{
"type": "GfxResolutionChanged",
"width": 1920,
"height": 1080
}
Notification
Sent when various system or network conditions change. Includes severity and optional data.
{
"type": "Notification",
"state": "Set",
"notification": {
"type": "Disconnected",
"severity": "Error",
"message": "Receiver disconnected from preset",
"data": {
"type": "NoNotificationData"
}
}
}
OsdAction
An action needs to be taken in the OSD.
{
"type": "OsdAction",
"action": "ShowBanner",
"severity": "Notice",
"str": "System update available"
}
OsdTouchLaunchUpdated
Touch launch status has changed.
{
"type": "OsdTouchLaunchUpdated",
"enabled": true
}
SinkPortSettingsUpdated
Sink port settings have changed.
{
"type": "SinkPortSettingsUpdated",
"portType": "video",
"portId": 5
}
UiSettingsUpdated
UI settings related to a user account have been updated.
{
"type": "UiSettingsUpdated",
"userId": 42
}
Notes
- All events are JSON objects with a top-level `type` field.
- The WebSocket server uses a self-signed certificate. Ensure your client supports bypassing cert validation in development environments.