Skip to main content

Chat Out

Signals the end of a chat interaction and sends a completion message to the client.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • Session Id - Unique identifier for the UI client connection.

Options​

  • None

Output​

  • None (this is a terminal node)

How It Works​

The Chat Out node signals the end of a chat interaction by sending a completion message to the client. When executed, the node:

  1. Validates the provided Session ID
  2. Retrieves the session information for the provided ID
  3. Constructs a chat out message with the session ID
  4. Sends the message to the client through the websocket connection

Requirements​

  • A valid session ID for an active client connection
  • Active websocket connection to the client

Error Handling​

The node will return specific errors in the following cases:

  • Empty or invalid Session ID
  • Session not found for the provided ID
  • Failed to send chat out message to client

Usage Notes​

  • This node should be placed at the end of flows that interact with chat clients
  • It signals to the client that the interaction is complete
  • The Session ID must match an active client connection
  • No further processing occurs after this node in the flow