Reference Triggers Websocket

WebSocket triggers

Also on the Cuebot Docs site.

Client: connected

Runs when Cuebot connects to another program over a WebSocket (an open line two programs use to chat quickly).

Setting	What to put in
Client	Only run for the WebSocket client with this name (a connection Cuebot makes to another program). Leave empty for any client.

Variables you get

Variable	What it holds
%clientName%	The client's name
%url%	The address it connects to

Type id: websocket.clientOpen

Client: disconnected

Runs when Cuebot's WebSocket connection to another program ends.

Setting	What to put in
Client	Only run for the WebSocket client with this name (a connection Cuebot makes to another program). Leave empty for any client.

Variables you get

Variable	What it holds
%clientName%	The client's name
%url%	The address it connects to
%reason%	Why it ended: disconnected (on purpose) or closed (by the other side)

Type id: websocket.clientClose

Client: message

Runs when the other program, which Cuebot is connected to over a WebSocket, sends Cuebot a message.

Setting	What to put in
Client	Only run for the WebSocket client with this name (a connection Cuebot makes to another program). Leave empty for any client.

Variables you get

Variable	What it holds
%clientName%	The client's name
%url%	The address it connects to
%message%	The text it sent

Type id: websocket.clientMessage

Custom server: connection closed

Runs when a program disconnects from one of your own WebSocket servers.

Setting	What to put in
Server	Only run for the WebSocket server with this name (a server you made in Cuebot that other programs can connect to). Leave empty for any server.

Variables you get

Variable	What it holds
%serverName%	The server's name
%sessionId%	Which connected program this is
%remote%	Where the program connected from

Type id: websocket.serverClose

Custom server: connection opened

Runs when another program connects to one of your own WebSocket servers. A WebSocket is an open line two programs use to chat quickly.

Setting	What to put in
Server	Only run for the WebSocket server with this name (a server you made in Cuebot that other programs can connect to). Leave empty for any server.

Variables you get

Variable	What it holds
%serverName%	The server's name
%sessionId%	Which connected program this is
%remote%	Where the program connected from

Type id: websocket.serverOpen

Custom server: message

Runs when a program connected to your own WebSocket server sends Cuebot a message.

Setting	What to put in
Server	Only run for the WebSocket server with this name (a server you made in Cuebot that other programs can connect to). Leave empty for any server.

Variables you get

Variable	What it holds
%serverName%	The server's name
%sessionId%	Which connected program this is
%remote%	Where the program connected from
%message%	The text it sent

Type id: websocket.serverMessage