Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

JSON data type

Store JSON formatted text values. JSON values can be generated by integration steps or by scripts.

Basic options

OptionDescription
LabelDisplays the label used to identify the data variable in the Workflow Studio interface. The label can consist of any text.
NameDisplays the name used to identify the data variable in script calls. The name can only consist of alphanumeric and underscore characters. The system automatically converts the label into a valid name by removing or replacing any special characters.
TypeIndicates the type of data stored by the data variable.
MandatoryIndicates whether the data variable must contain a value when configured in an action.

Advanced options for JSON variables

OptionDescription
HintProvides guidance to flow or action designers on how to configure the data.
Default valueSpecifies the value used when a flow or action designer does not provide a value.

Choice list items as a JSON array

This example shows storing three choices of a choice list field as JSON formatted text. In this example, the data attribute has an array of three objects as its value. Each object in the array has label and name attributes.

{
    data: [
        {
            label: "Choice Option 1",
            name: "choice_option_1"

        }, 
        {
            label: "Choice Option 2",
            name: "choice_option_2"
        }, 
        {   
            label: "Choice Option 3",
            name: "choice_option_3"
        }
    ]
}

Parent Topic:Workflow Studio input and output data variables