The Custom Fields module captures additional user-provided data and saves it to the Session, making it available for reporting, server-side decisions, or cross-checking later in the journey. The data can either be collected from the user in the UI or supplied through the back end via API.
Warning
This module is deprecated. Existing implementations may continue use, but it is not available in new implementations.
Integrations
:white_check_mark: Web | :x: iOS | :x: Android
{/* TODO: Confirm SDK support with PM - above info is from NotionAI */}
How It Works
Custom fields are first defined in Dashboard, where each field is given a name and a type (number, string, Boolean, or date). Once defined, they can be populated in two ways:
- Collected in the UI: When the Custom Fields module is added to a Flow, it presents a form to the user during verification. On submit, the values are saved to the Session.
- Sent via the backend: When the module is not added, the values are expected through the backend via API and saved to the Session.
Either way, the data lands in the Session's custom fields payload, where it can be referenced by other modules or retrieved server-side after the Session completes.
Use Custom Fields
For instructions on adding and configuring the Custom Fields module on each supported platform, use the following pages: