Skip to main content

Checkboxes

Creates 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​

  • ID - The unique identifier for the checkbox group.

Options​

  • Options - An array of text options for the checkboxes.
  • Custom Options - An array of custom option objects with additional properties.

Output​

  • Payload - The response object containing information about the user's checkbox selections.

How It Works​

The Checkboxes node creates interactive checkboxes in chat interfaces. When executed, the node:

  1. Creates a group of checkboxes with the specified options
  2. Displays the checkboxes in the chat interface
  3. Waits for user interaction with the checkboxes
  4. Returns a payload with information about the user's selections

Requirements​

  • A valid chat interface or messaging platform
  • Properly configured checkbox options or custom options

Error Handling​

The node will return specific errors in the following cases:

  • Empty or invalid ID
  • Invalid option format
  • Issues with custom option objects
  • Communication errors with the messaging platform

Usage Notes​

  • Checkbox options are displayed as a group for user selection
  • Users can select multiple checkboxes from the group
  • The payload output contains information about which checkboxes were selected
  • Checkbox groups are useful for collecting multiple user preferences
  • Both Options and Custom Options can be used together to define the checkbox items