Stream Kit DocsAPI ReferenceWebSocket
Message Received
WebSocket trigger: websocket:websocket:message-received
Message Received
| Trigger ID | websocket:websocket:message-received |
| Plugin | WebSocket |
| Category | WebSocket |
Variables
Copy variables into handler fields using {variableName} syntax.
{connectionId}{connectionName}{url}{message}{event}{data}{isJson}{affectedConnectionIds}| Name | Type | Description |
|---|---|---|
{connectionId} | string | Configured WebSocket connection ID. Example: |
{connectionName} | string | Display name of the WebSocket connection. Example: |
{url} | string | WebSocket server URL. Example: |
{message} | string | Full message text from the event. |
{event} | — | Lifecycle or queue event name. Example: |
{data} | unknown | Parsed JSON payload from the WebSocket message. |
{isJson} | boolean | Whether the received payload parsed as JSON. Example: |
{affectedConnectionIds} | string | Connection IDs affected by a broadcast event. |
Conditions
| Condition | Description |
|---|---|
| Connection | Restrict to one configured WebSocket connection. Leave empty to match any connection. |
| Message | Match message text (starts with, ends with, contains, equals). Leave empty to always match. |
| JSON field | Match a field inside JSON using a dot-path and text operator. |