Skip to main content

Chat In

Receives incoming messages from chat clients and extracts session information.

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​

  • None (this is a trigger node)

Options​

  • Mode - Specifies the chat mode. Can be either "Guided" or "Conversational".

Output​

  • Session Id - Unique identifier for the UI client connection.
  • Payload - Payload of the user message in conversational mode.
  • Additionals - Additional information about flow and instance.
  • Profile - Profile information about client if Robomotion session exists.

How It Works​

The Chat In node acts as a trigger that starts a flow when a message is received from a chat client. When a message is received, the node:

  1. Extracts the session ID from the incoming message
  2. Validates that the session ID is not empty
  3. Retrieves session information including additional data and profile information
  4. In conversational mode, extracts the message payload
  5. Outputs the session information and payload (if applicable)

Requirements​

  • An active connection to the chat proxy
  • Valid session IDs from connected clients

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 set session ID, additionals, profile, or payload

Usage Notes​

  • This node should be the starting point of flows that respond to chat messages
  • In Guided mode, the flow follows a predetermined path with specific widgets
  • In Conversational mode, the flow processes natural language messages
  • The Payload output is only available in Conversational mode
  • The Profile output contains client information if a Robomotion session exists
  • The Additionals output contains information about the flow and instance