Skip to main content

Dropdown

Displays a dropdown selection widget for users 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 dropdown.
  • Description - Optional description for the dropdown.
  • Placeholder - Optional placeholder text for the dropdown.

Options​

  • Dropdown Array - Array of options to display in the dropdown.
  • Custom Options - Custom options for the dropdown.

Output​

  • Result - User selection from the dropdown.

How It Works​

The Dropdown node creates an interactive widget that allows users to select an option from a dropdown list. When executed, the node:

  1. Validates the provided Session ID
  2. Checks that the session is not in conversational mode
  3. Builds the dropdown options from the provided array or custom options
  4. Creates a dropdown widget with the specified label, description, and placeholder
  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 dropdown 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
  • Dropdown list is required but not provided
  • Failed to build dropdown options
  • Cannot use dropdown 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, Description, and Placeholder fields are optional but can help users understand what they're selecting
  • Users can only select one option from the dropdown
  • The returned selection will be in the format provided by the client (JSON or string)
  • Dropdowns cannot be used in conversational mode