Websocket Client Message

Preview

Parameters

Clientrequired

Select

Select a client from the Server/Clients -> Websocket Clients tab

The following variables will be populated when this trigger executes:

		Description
`message`	`string`	The websocket client message Example: `{"timeStamp":"2023-03-16T22:58:28.3298+01:00","event":{"source":"HotKey","type":"Press"},"data":{"_85lbxopeOGvkNXq7iRgrjS6tpjj":1,"_hdhxue62iGbvG5rnMWU0dxGe29p":96}}`

		Description
`wsHost`	`string`	The host of this websocket client Example: `127.0.0.1`
`wsId`	`string`	The UUID of this websocket client
`wsIdx`	`number`	The 0-based id of this websocket Example: `0, 1, 2, etc.`
`wsName`	`string`	The custom defined name of this websocket client Example: `My websocket client`
`wsPath`	`string`	The path of this websocket client Example: `/`
`wsPort`	`number`	The port of this websocket client Example: `8080`
`wsQuery`	`string`	The query of this websocket client Example: `?key=value`
`wsScheme`	`string`	The scheme of this websocket client Example: `ws`
`wsUrl`	`string`	The full URL of this websocket client Example: `ws://127.0.0.1:8080/`

General variables are generated by all triggers and are available within all action executions.

		Description
`__source`	`EventType`	The event which triggered the action. This will not always exist and requires C# to access, read more Example: `TwitchChatMessage`
`actionId`	`Guid`	The unique ID of the action being executed Example: `2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`actionName`	`string`	The name of the action being executed Example: `My Action`
`actionQueuedAt`	`DateTime`	The timestamp of when action was queued Example: `12/21/2023 9:25:21 AM`
`eventSource`	`EventSource`	The service of the event which triggered the action. This will not always exist and requires C# to access, read more Example: `twitch`
`runningActionId`	`Guid`	The unique ID of this running action instance within the queue Example: `c83dd939-9f86-4435-b07c-b6e7e3eef134`
`triggerCategory`	`string`	The category of the trigger which executed the action Example: `Twitch/Chat`
`triggerId`	`Guid`	The unique id of the trigger with executed the action Example: `2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`triggerName`	`string`	The name of the trigger which executed the action Example: `Chat Message`

Websocket Client Closed

Trigger for when the Websocket Client connection is Closed

Websocket Client Open

Trigger for when the Websocket Client connection is Opened