Skip to main content

Workflow Attributes

Attributes are a workflow's inputs. When someone picks the workflow under Build → Missions, each attribute appears on the launch form. The values they enter are available to every node as ${attribute.name}.

Add an attribute​

  1. Open the workflow in the builder.
  2. Click the settings (gear) button next to the workflow name.
  3. Under Workflow Attributes, click Add Attribute.
  4. Fill in the fields:
FieldWhat to enter
NameThe identifier, for example topic. Referenced as ${attribute.topic}. Use letters, numbers and underscores. Names must be unique.
TypeText Input, Dropdown, Checkbox or Button.
Number of LinesText Input only. 1–20. More than one line gives a multi-line box.
DescriptionShown as the field's label on the launch form. If blank, the name is shown.
Default ValuePre-filled on the launch form.
RequiredMarks the field as required on the launch form.
Dropdown OptionsDropdown only. Type an option and press Enter or click Add.
TriggerButton only (the rocket icon). Makes this button the form's launch button.
  1. Save the workflow.

Use the up and down arrows to reorder attributes — the launch form shows them in this order. The bin icon removes one.

For each type's behaviour on the launch form, see Workflow Attribute Types.

Use attributes in nodes​

Type $ in any Input Message Template or function argument and pick the attribute, or click its chip under Attributes:.

Research ${attribute.topic} for a ${attribute.audience} audience.
Produce a ${attribute.report_format} report.

Attributes also appear in Condition rules as Attribute: name, so you can branch on them.

When attributes are filled in​

How the run startsAttribute values
Launched from MissionsWhat the person entered (pre-filled with defaults).
Re-run from mission historyThe values from the original run.
Run Workflow in the builderNone.
Schedule, webhook, or a parent workflow's Mission nodeNone — default values are not applied.
APIWhatever the caller supplies.

If a workflow will run on a schedule or from a webhook, don't depend on attributes. Put the fixed text in the node itself.

Things to know​

  • Required isn't enforced. The field is shown as required, but the mission can still launch with it empty.
  • A workflow with no attributes launches as soon as it is selected on the Missions page — including the first workflow in the list, which the page selects when it opens. Opening Missions from a workflow's Run button doesn't do this. Add an attribute if you want people to confirm first.
  • Checkbox values are inserted into text as True or False.