A Dictionary Field is used when you need to send multiple key-value pairs in a workflow.

It is commonly used for:

• custom fields,

• metadata,

• attributes,

• extra properties,

• or dynamic API data.

Simple flow:

User adds keys and values → The data is sent as an object in the workflow

A Dictionary Field works using:

• Key → Field name

• Value → Field value

Example:

This gets sent in the workflow like this:

{
  "first_name": "Nishit",
  "company": "Walkover",
  "city": "Indore"
}

Use a Dictionary Field when:

• the API expects object data,

• users need to add custom fields,

• field names may change dynamically,

• or multiple values need to be grouped together.

Good examples:

Open the action where you want to add the field.

Inside the Action Builder, go to the right-side panel and click on the ADD FIELD dropdown.

Choose Dictionary from the list of available field types.

Fill in the field details:

[...][
  {
    "key": "custom_fields",
    "type": "dictionary",
    "label": "Custom Fields",
    "help": "Enter the custom fields in key-value pairs",
    "required": true,
    "template": {
      "key": {
        "type": "string",
        "placeholder": "Enter key"
      },
      "value": {
        "type": "string",
        "placeholder": "Enter value"
      }
    }
  }
]

Click anywhere outside the field settings panel to automatically save the field.

Here’s a simple Dictionary Field setup:

Example workflow data:

{...}{
  "custom_fields": {
    "city": "Indore",
    "company": "Walkover",
    "source": "Website"
  }
}

• Use Dictionary Field for dynamic or flexible data

• Match keys with the API field names whenever possible

• Use lowercase keys with underscores for better consistency

• Check the API documentation before adding custom keys

• Keep keys short and meaningful

Good key examples:

• first_name

• company_name

• customer_type

• custom_fields

Avoid keys like:

• First Name

• My Field

• Company Name

Use a Dictionary Field when your workflow needs to send multiple dynamic key-value pairs.

It helps:

• support flexible API structures,

• send custom fields,

• and handle dynamic workflow data more efficiently.