← All native models

Native model

journey_field

Declare a named journey_field value and reference it as journey_field.your_name. Models have no separate platform identity or lifecycle.

Topics: Surfaces

Fields

A question on a form stage. The answer is written to Journey state under its key

object
conditionOptional
defaultValueOptional

Initial value, written to state the first time the stage shows if the key has no value yet. For a choice field it must be one of the option values; for a date field it is an ISO date such as 2026-09-29.

string
helpOptional

Short explanation shown under the field.

string
keyRequired

State key the answer is written to, read as $.state.<key>.

string
kindRequired

Type of control, which also sets the type of the answer.

string
Allowed values
["text","multiline","number","toggle","choice","date","resourcePicker"]
labelRequired

Label shown to the user.

string
optionsOptional
array
Minimum items
0
Maximum items
9223372036854776000
List items
placeholderOptional

Hint text shown inside the empty field.

string
requiredOptional

Set to true to require an answer before the user can continue.

boolean
resourceTypeOptional

The kind of record to pick. Required when kind is resourcePicker.

string
Allowed values
["customer","order","job","workcenter"]
validationOptional

Only the fields listed here are accepted.