Understand form data
What form data is
Form data is data associated with a conversation. Each piece of data has two parts:
- Key - the name of the data, such as
email,region,serial-number, and so on. - Value - the content of the data, such as
[email protected],US,EN-2721, and so on.
How form data gets set
There are several ways form data can be set for a given conversation.
Entered by the user
Forms can be added to question or message nodes to prompt the user to manually enter information as appropriate.
Form data entered by the user can be marked as PII. This will prevent the data from being stored in Mavenoid's servers; it will only be stored in the user client and used within the flow and its transcript.
Write data node
Write data nodes can set any number of form data keys to specified values.
External API
External API nodes can access an external API and then set any number of form data keys to values based on the API's response.
External script
External script nodes can run an external script and then store the output as the value for a given form data key.
Form data set by an external script node can be marked as PII. This will prevent the data from being stored in Mavenoid's servers; it will only be stored in the user client and used within the flow and its transcript.
External script functionality is currently experimental. To work with external script nodes, please reach out to your Mavenoid representative.
How form data gets used
There are a few ways form data can be read or used.
Read data node
A read data node can fork a flow's behavior based on the value of specified form keys.
External API
External API nodes can use form data to dynamically generate URLs and payloads for API requests.
Conversation transcript
Form data is included in all transcripts of a conversation that are sent via email or used to create external tickets.
Agent dashboard
Form data is included in conversation details viewed in the agent dashboard.