Dynamic data

Dynamically renders content from an API response stored in a variable. Use Dynamic data when the content or options are not known in advance and need to be fetched at runtime, such as available appointment slots, order history, branch locations, live inventory, or product lists.

Available on the Premium plan and above.

Dynamic data can generate: Using this block, you can dynamically display list items for,

Button
Carousel
Option (WhatsApp and SMS)
List (WhatsApp)
Reply button (WhatsApp)
File

Use Options or List when you define the choices yourself. Use HTTP request when you need to retrieve API data without rendering it as dynamic content.

Dynamic data renders the generated content according to the capabilities of the channel. On supported channels, users see the configured interactive component.

Using the Dynamic data block

Fetch the data

Use the HTTP request action block to call your API.Configure the request with the endpoint, authentication, headers, query parameters, or request body required by your API.

Store the response

Store the complete API response in a variable.For example:

response

Make sure you store the entire payload response in the variable. Do not append an object path after the response when mapping it to the variable.

Configure Dynamic data

Add the Dynamic data action block after the HTTP request block and connect it to the next step.Select the response variable in Data variable, then select how you want to render the response using Render as.

HTTP request configuration

Before configuring Dynamic data, configure the HTTP request that retrieves the data.

Setting	Description
Endpoint	Enter the API URL and select the HTTP method required by the API.
Headers and authentication	Add the headers and authentication credentials required by the API.
Request body	Add the request body when required by the API. You can include variables from the conversation.
Query parameters	Add query parameters required by the API. You can include variables from the conversation.
Response variable	Store the complete API response in a variable that can be selected in Dynamic data.

For example:

GET https://api.example.com/appointments?date={{appointment_date}}

For a POST request:

{
  "customer_id": "{{customer_id}}",
  "date": "{{appointment_date}}"
}

Dynamic data does not make the API request itself. The HTTP request block retrieves the data, and Dynamic data uses the response stored in the selected variable.

Configuration

Data variable

Select the variable containing the complete API response. For example:

response

Render as

Choose the type of content that Dynamic data should generate.

Render as	Channel	Use it for
Button	Web, Instagram, Facebook, API	Dynamic buttons that branch the conversation or open a URL.
Carousel	Web, Instagram, Facebook, API	Dynamic cards with content and actions.
Option	WhatsApp, SMS	Dynamic selectable options.
List	WhatsApp, API	Dynamic list items.
Reply button	WhatsApp, API	Dynamic reply buttons.
File	Web, WhatsApp, Instagram, Facebook, API	Dynamic files returned by the API.

Bot asks this question

Enter the question or message displayed before the dynamic content. For example:

Which product would you like to select?

You can reference variables in the question by typing #.

Response mapping

Map the fields from the API response to the fields required by the selected render type. For example, for a Button:

Button title — the text displayed to the user.
Button payload — the value associated with the selected button.

For example:

Button title:
data.products[*].name

Button payload:
data.products[*].id

Array path

The array path identifies where the list of items is located in the response. For example:

{
  "data": {
    "products": [
      {
        "id": "P-101",
        "name": "Premium Plan"
      }
    ]
  }
}

The array path is:

data.products

The fields inside each item can then be mapped using:

data.products[*].name
data.products[*].id

Use [*] when you want to retrieve a field from every item in an array.

Empty response handling

Handle cases where the API request succeeds but does not return any items. For example:

No products are currently available.

Use a clear message or connect the empty-response path to an alternative flow.

Save response

Select the variable where the user’s selected response should be stored.

Save button payload response

Select a variable to save the button payload when the user selects an item. The button payload is a value you define for each item. It can be different from the text displayed on the button and can be used later in a Condition block to determine which path the user should follow. For example:

Button title:
View Cart

Button payload:
cart

You can use the payload later when an internal ID or another value is required by a subsequent API request.

Configuring list items

After selecting the render type, map the object paths from the API response to the fields required by that render type. For example, if the payload response stored in the variable is:

[
  {
    "product_id": "123",
    "status": "pending"
  },
  {
    "product_id": "456",
    "status": "delivered"
  },
  {
    "product_id": "798",
    "status": "pending"
  }
]

To render product_id as a button, use:

[*].product_id

The [*] indicates that the field should be retrieved from every item in the array. The resulting buttons are:

123
456
798

If the response is wrapped inside a result object:

{
  "result": [
    {
      "product_id": "123"
    },
    {
      "product_id": "456"
    }
  ]
}

the object path becomes:

result[*].product_id

Nested JSON

Nested JSON is one of the most common areas where object-path mapping can become confusing. When the field you need is nested inside multiple objects, include every level of the response in the object path. For example:

{
  "result": {
    "locations": {
      "available": [
        {
          "branch": {
            "id": "BR-101",
            "name": "Ahmedabad"
          }
        },
        {
          "branch": {
            "id": "BR-102",
            "name": "Mumbai"
          }
        }
      ]
    }
  }
}

1. Find the array
2. Find the label
3. Find the value
4. Result

The list of items is inside:

result.locations.available

Use this as the array path.

The branch name is inside branch, which is inside each item.Use:

result.locations.available[*].branch.name

The branch ID is:

result.locations.available[*].branch.id

The user sees:

Ahmedabad
Mumbai

The corresponding values are:

BR-101
BR-102

When mapping nested JSON, start from the root of the stored response and follow each level until you reach the field you need. Add [*] at the array level.

Output paths

Use the output paths to handle the different results of the Dynamic data request.

Output path	When it runs
Items returned	The API returns one or more items that can be rendered.
Empty response	The API request succeeds but no items are returned.
Request failed	The API request fails or the response cannot be processed.

Connect each path to the appropriate next block in your flow.

Add an alternative message or flow for empty responses and failed requests so the conversation does not stop unexpectedly.

Variables set

Dynamic data can save the user’s selected response and, where applicable, the selected button payload. For example:

Button title:
Ahmedabad Branch

Button payload:
BR-101

Save the selected response as:

selected_branch = Ahmedabad Branch

and the payload separately as:

selected_branch_id = BR-101

These variables can be used in subsequent blocks, conditions, or API requests.

Common mistakes

The complete API response was not stored

Make sure the HTTP request stores the complete API response in the Data variable.If only part of the response is stored, Dynamic data may not be able to access the fields you need.

Using the wrong object path

Include every level of the JSON structure.

Correct:
data.products[*].name

Incorrect:
products[*].name

Missing [*]

Use [*] when mapping a field from every item in an array.

data.products[*].id

Using result when the response is already an array

If the stored response is:

[
  {
    "product_id": "123"
  },
  {
    "product_id": "456"
  }
]

the correct path is:

[*].product_id

not:

result[*].product_id

Use result[*].product_id only when the response actually contains a result array.

Skipping a level in nested JSON

If the response contains:

data.products[*].details.name

do not use:

data.products[*].name

Include every level between the array and the field you want.

Advanced settings

Enable search

Enable this option to let users search through the dynamically generated items.Use it when the API returns a large number of items and users need an easier way to find a specific item.

Enable multi-select

Enable this option to allow users to select multiple items from the dynamically generated options.Use it when the user needs to choose more than one item.

Enable free text

Enable this option to allow users to enter a text response instead of selecting one of the dynamically generated options.

Buttons layout

Choose how dynamically generated buttons are arranged:

Horizontal — displays buttons next to each other.
Vertical — displays buttons one below another.

Buttons sorting

Choose the order in which dynamically generated buttons are displayed:

A–Z — sorts buttons alphabetically from A to Z.
Z–A — sorts buttons alphabetically from Z to A.
Random — displays buttons in a random order.
As defined — keeps the same order as the items returned by the API.

Select As defined when the order returned by your API is important and should be preserved.

Add an info message

Enable this option to display an informational message with additional context for the dynamically generated content.Use it when users need additional instructions or context before making a selection.

Track link clicks on this message

Enable this option to track clicks on links included in the info message.Use it when you want to measure engagement with links displayed in the message.

Getting started

Build

Operate

Deploy

Reports

Account

Using the Dynamic data block

HTTP request configuration

Configuration

Data variable

Render as

Bot asks this question

Response mapping

Array path

Empty response handling

Save response

Save button payload response

Configuring list items

Nested JSON

Output paths

Variables set

Common mistakes

Advanced settings

​Using the Dynamic data block

​HTTP request configuration

​Configuration

​Data variable

​Render as

​Bot asks this question

​Response mapping

​Array path

​Empty response handling

​Save response

​Save button payload response

​Configuring list items

​Nested JSON

​Output paths

​Variables set

​Common mistakes

​Advanced settings

Using the Dynamic data block

HTTP request configuration

Configuration

Data variable

Render as

Bot asks this question

Response mapping

Array path

Empty response handling

Save response

Save button payload response

Configuring list items

Nested JSON

Output paths

Variables set

Common mistakes

Advanced settings