Skip to main content

Checkbox

Displays a group of checkboxes for user selection in chat interfaces.

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.
  • Label - Optional label for the checkbox group.
  • Description - Optional description for the checkbox group.

Options​

  • Checkbox Array - Array of checkboxes to display.
  • Custom Options - Custom options for checkboxes.

Output​

  • Result - User selection result from the checkbox group.

How It Works​

The Checkbox node creates an interactive widget with multiple checkboxes that users can select from. When executed, the node:

  1. Validates the provided Session ID
  2. Checks that the session is not in conversational mode
  3. Builds the checkbox options from the provided array or custom options
  4. Creates a checkbox widget with the specified label and description
  5. Sends the widget to the client with the specified session ID
  6. Waits for the user's selection
  7. Parses the response as JSON or string
  8. Returns the parsed selection as the result

Requirements​

  • A valid session ID for an active client connection
  • Properly configured client interface that can handle checkbox widgets
  • Session must not be in conversational mode

Error Handling​

The node will return specific errors in the following cases:

  • Empty or invalid Session ID
  • Session not found for the provided ID
  • Checkbox list is required but not provided
  • Failed to build checkbox options
  • Cannot use checkbox in conversational mode
  • Failed to send widget to client
  • Timeout while waiting for user selection
  • Failed to parse user response

Usage Notes​

  • The Session ID must match an active client connection
  • The Label and Description fields are optional but can help users understand what they're selecting
  • Users can select multiple checkboxes
  • The returned selection will be in the format provided by the client (JSON or string)
  • Checkboxes cannot be used in conversational mode