List

Renders a list of items grouped by categories on a drawer.

Available on WhatsApp for the WA API providers: 360Dialog, Meta, and GupShup.

This action block is used for a rich approach of allowing users to choose from a list of options.

Most commonly, it is used as an alternative to the Option action block, as it it not user-friendly and prone to users from the users.

Preview of list on WhatsApp

List action block is made up of the following:

  1. Header

  2. Body

  3. Footer

  4. Button name

  5. Items & categories

  6. Error message

  7. Variable

Configure the question

Shows the text in a bold format -- making it look like a title. It is an optional field.

Body

The text will be the question associated with showing the list of options.

For example, "Select the service you are interested in".

The text is displayed in a small grey color format. Mostly used to display a disclaimer to the user when selecting the option from the list.

Configure the list items

Button name

Along with the above, a button will be displayed, on click of which we will show the list of options in a drawer format.

You can write the button's name here, such as 'Choose', 'Select', etc.

Items & Categories

All the items that are to be displayed in the list are defined here.

Each item contains the following information,

  • Item name — Name of the item

  • Item description — A short description of the item

  • Category — List of all categories created. It is optional.

  • Button payload — Button payload is like a hidden label you attach to each item in your list.

On the bot builder canvas, for each list item, you will see a new branch created. You can use this to create personalized flows.

A maximum of 10 items and categories can be created.

Using button payload

When the user clicks an item, this hidden label gets saved using the “Save button payload response” option. This means the bot remembers which item the user selected.

Later, in the Condition block, you check this saved label (payload value) to decide where to send the user.

Example:

  • You set the button payload as “cart” for Item 1 and Item 2

  • The user clicks Item 1 → the bot saves “cart” because of “Save button payload response”

  • In the Condition block, you check: “If saved value = cart → go to Cart Flow”

So, button payload helps the bot know which item was selected and route the user correctly.

Variable

Users can store the value of the selected list item in a variable for future reference.

Learn more

Enable free text

By enabling "Enable free text" option, users can either choose from predefined buttons or type their own response in the chat input. Also, on the canvas a new "Free text" node will be added, which can be connected to an AI agent action block for AI-generated responses.

This allows for more natural, two-way conversations, and any free text entered can be handled by an AI agent for dynamic responses.

Last updated

Was this helpful?