Skip to main content

Workflow Attribute Types

Attributes are edited in the builder under the workflow settings (gear) button → Workflow Attributes. For a walkthrough, see Workflow Attributes.

Fields​

FieldKeyTypeApplies toNotes
NamenameTextAllRequired and unique within the workflow. Referenced as ${attribute.<name>} (or ${<name>}).
TypetypeSelectAllText Input (freeform), Dropdown (dropdown), Checkbox (checkbox), Button (button). Changing away from Dropdown clears its options.
Number of LineslinesNumber, 1–20Text InputDefault 1.
DescriptiondescriptionTextAllUsed as the label on the launch form; the name is used if blank.
Default Valuedefault_valueTextAllPre-fills the launch form. Not applied to scheduled, webhook or sub-workflow runs.
RequiredrequiredCheckboxAllShows the field as required. Not enforced.
Dropdown OptionsoptionsList of textDropdownThe API's validation requires at least one option.
Triggeris_triggerCheckboxButtonMakes the button the form's launch button.

How each type appears on the launch form​

TypeOn the Missions launch formValue passed to the run
Text InputA large text box, labelled with the description. The default value (or a prompt) shows as placeholder text. Pressing Enter launches the mission; Shift+Enter adds a new line.The text entered.
DropdownA drop-down with None plus your options.The selected option, or empty.
CheckboxA checkbox.true or false (inserted into text as True / False).
Button (not a trigger)A secondary button. Clicking it sets the value.true once clicked.
Button with TriggerThe main launch button, labelled with the description.true.

If no attribute is a trigger button, the form shows a Launch Mission button. A workflow with no attributes at all launches as soon as it is selected.

New workflow defaults​

NameTypeDescriptionRequiredTrigger
UserInputText InputEnter your requestYes—
StartMissionButtonGoNoYes

UserInput is not passed to any node automatically. Reference ${attribute.UserInput} in the first node's input message.