Trigger Schema

Triggers run actions when an expression becomes true. Prefer simpler properties like visibleIf, enableIf, setValueIf, and setValueExpression unless a root-level trigger is specifically needed.

Common Trigger Types

• setvalue — set a question value
• copyvalue — copy one question value to another
• skip — skip to another page
• complete — complete the form

Minimal Shape

{
  "type": "setvalue",
  "expression": "{sameAsBilling} = true",
  "setToName": "shippingAddress",
  "setValue": "{billingAddress}"
}

Properties

type

• Type: string
• Required: Yes

Trigger type.

expression

• Type: expression
• Required: Yes

Boolean expression that activates the trigger.

setToName

• Type: string

Question or calculated value name to update.

setValue

• Type: value | expression

Value assigned by a setvalue trigger.

fromName

• Type: string

Source question for a copyvalue trigger.

gotoName

• Type: string

Page or question name used by skip-style triggers.

Example

{
  "triggers": [
    {
      "type": "complete",
      "expression": "{screenOut} = true"
    }
  ]
}