Dynamic Dropdown
What is a Dynamic Dropdown?
A Dynamic Dropdown allows users to select a value from a list of options that are loaded automatically from an API or external data source.
Unlike a Static Dropdown, the available options are not manually defined. Instead, they are fetched when the field is loaded.
This is useful when the available options:
vary between accounts,
change frequently,
or come from another application.
Simple flow:
System fetches data from an API → Options appear in the dropdown → User selects a value
When to use a Dynamic Dropdown?
Use a Dynamic Dropdown when:
options come from an external system,
available values change over time,
different users may see different options,
or the list is too large to maintain manually.
Good examples:
Use Case | Example |
|---|---|
Users | Select a user from the connected account |
Projects | Select a project from a project management tool |
Companies | Select a company from a CRM |
Pipelines | Select a sales pipeline |
Databases | Select a database from a connected workspace |
How does a Dynamic Dropdown work?
Step | What Happens |
|---|---|
1 | The field loads |
2 | The system calls an API |
3 | The API returns a list of records |
4 | Records are converted into dropdown options |
5 | User selects an option |
Example flow:
API Request → API Response → Dropdown Options → User Selection
How to add a Dynamic Dropdown?
Step 1 - Open Your Action
Open the action where you want to add the dropdown field.
Step 2 - Click “ADD FIELD”
Inside the Action Builder, go to the right-side panel and click on the ADD FIELD dropdown.
Step 3 - Select “Dropdown”
Choose Dropdown from the list of available field types.
Step 4 - Select “Dynamic Dropdown”
Choose the Dynamic Dropdown type.
Step 5 - Configure the Field
Fill in the dropdown details:
Property | Value | Example |
|---|---|---|
Value | dropdown | dropdown |
Label | Field name shown to users | Project |
Key | API parameter name | project_id |
Required | Makes the field mandatory | Yes / No |
Help | Text displayed on hover for user guidance | Select a project |
Placeholder | Default text shown before selection | Select Project |
API URL | Endpoint used to fetch dropdown options |
|
Method | HTTP method used to fetch data | GET |
Label Field | API field displayed to users | name |
Value Field | API field sent in the workflow | id |
Visibility Condition | Hide/show field based on some condition |
|
Custom Help | Additional guidance shown below the field | Choose a project from your workspace |
Custom Input Label | Label shown above the dropdown | Project |
Custom Placeholder | Example placeholder shown inside the dropdown | Select a project |
Step 6 - Configure option mapping
The API response must contain data that can be converted into dropdown options.
Example API response:
[...][ { "id": "123", "name": "Website Redesign" }, { "id": "456", "name": "Marketing Campaign" } ]
Mapping:
API Field | Purpose |
|---|---|
name | Displayed to users |
id | Sent in the workflow |
Result:
User Sees | Workflow Sends |
|---|---|
Website Redesign | 123 |
Marketing Campaign | 456 |
Additional Features
Search
Enable search when the API may return a large number of options.
This allows users to quickly find the value they need.
Example:
Search Project...Use search when:
there are many records,
users may not know where the option is located,
or the list changes frequently.
Pagination
Enable pagination when the API contains a large dataset.
Instead of loading everything at once, data is loaded in smaller batches.
This helps:
improve performance,
reduce API load,
and speed up dropdown loading.
Pagination is commonly used when:
thousands of records exist,
APIs return paginated results,
or large workspaces are supported.
Example
Here are some common Dynamic Dropdown setups:
Label | Data Source |
|---|---|
User | Connected Account Users |
Project | Project Management Tool |
Company | CRM Companies |
Pipeline | CRM Pipelines |
Best Practices & Recommendations
Use Dynamic Dropdown when data comes from an external system
Use meaningful labels that users can easily recognize
Map values to unique identifiers whenever possible
Enable search for large datasets
Enable pagination when supported by the API
Test option loading before publishing the action
Key Takeaways
Use a Dynamic Dropdown when the available options need to be loaded automatically from an API or external system.
It helps:
keep data up to date,
reduce manual maintenance,
and provide users with real-time options from connected applications.
Remember:
Dynamic Dropdown = Options are loaded from an API → Users select from the available data