Stream Kit Docs
API ReferenceWebSocket

Connected

WebSocket trigger: websocket:websocket:connected

Connected

Trigger IDwebsocket:websocket:connected
PluginWebSocket
CategoryWebSocket

Variables

Copy variables into handler fields using {variableName} syntax.

{connectionId}{connectionName}{url}{affectedConnectionIds}
NameTypeDescription
{connectionId}
string

Configured WebSocket connection ID.

Example: test-connection

{connectionName}
string

Display name of the WebSocket connection.

Example: Test Connection

{url}
string

WebSocket server URL.

Example: ws://localhost:8080

{affectedConnectionIds}
string

Connection IDs affected by a broadcast event.

Conditions

ConditionDescription
ConnectionRestrict to one configured WebSocket connection. Leave empty to match any connection.

On this page