Fields
A field is a data input that a visitor sees inside a step. A field collects information such as a name, an email address, a preference, or a choice.
This page covers the experience field, which collects visitor input. An experience field is not the same as a content field. A content field is part of the schema of a CMS layout. See Models for those.
Field types
A field has one of many types. These are the common ones:
TEXT: A string input. Use it for a name, an email address, or free text.
NUMBER: A numeric input. Use it for a quantity, a rating, or an age.
BOOLEAN: A true or false toggle. Use it for a checkbox or for consent.
OBJECT: A structured data input. Use it for data that holds other data.
Options
Name: The name that the dashboard shows. Your visitors do not see it.
Key: The identifier for your application. You set it once and you cannot change it. Your visitors do not see it.
Label: The label that a visitor sees next to the field.
Placeholder: The hint text that the input shows while it is empty.
Description: A longer description of what the field is for. The dashboard shows it. Your visitors do not see it.
Help Text: Text below the field that helps your visitors.
Default Value: The value that the field holds when it loads.
Validation
Required: When this is on, a visitor must fill in the field before the flow can continue.
Validation rules: Conditions for a constraint such as a smallest value, a largest value, or a pattern. See Condition Builder for how to build a validation rule.
More than one value
Turn on Multiple to let a visitor send more than one value for the field. This is useful for an input that takes several choices, or for a field of tags.
Choices
For a field with a fixed set of choices, such as a dropdown or a set of radio buttons, add options. Each option has a value, and the response carries that value.
Each option can also carry a condition. When you set one, the option appears only to a visitor who matches the condition. See Condition Builder for more detail.
Privacy
A field captures nothing until you permit it. Two checkboxes control where the value of a field can go. Both start off.
| Checkbox | What it does when you turn it on |
|---|---|
| Remember in the browser | The SDK keeps the value on the device of the visitor. The value is available after a page load. |
| Send to analytics | Picked puts the value in your analytics events. |
Each checkbox is independent of the other.
A new field that you leave alone sends no value to your analytics. It writes no value to the browser. Keep both checkboxes off for sensitive data such as a password, a tax number, or a payment detail.
Never turn on Send to analytics for personal data. A name, an email address, a phone number, a home address, or an identity number must not reach your analytics.
Neither checkbox stops the flow from the use of the value inside the page. A field that captures nothing still holds its value there. The flow validates the step with it, and it evaluates the conditions after the step with it. The checkboxes control what leaves the page.
Related
-
How to write a condition — for a validation rule or an option condition.
-
SDK fields — the
policiesobject.