Form
Asking details using a webform
Last updated
Was this helpful?
Asking details using a webform
Last updated
Was this helpful?
When you need to elicit more than one piece of information you can use the form action. It is designed for web front-ends. One form can have multiple input fields. On other channels it will fallback to asking the form fields sequentially, like regular actions.
The fields to elicit can be configured as part of the action. In this example we configured three fields of type "Custom". They are required (so can't be skipped). By submitting, they will be stored in the conversation object in fields field1, field2 and field3.
The following parameters can be configured for a form:
Parameter
Description
Title
The title of the form, which will be used to display to the user
Don't allow to skip
Condition to action
Configuring a field starts with selecting the field type. This determines the other parameters of the field.
The following parameters can be configured:
Parameter
Description
Title
This is the caption of the field as shown in the form
Type
The type of data to expect (see below)
Required
Is this field required (it cannot be skipped) or not.
For the following field types, the behaviour and storage locations are predefined:
Type
Storage
Validation
first_name
user.first_name
none
last_name
user.last_name
none
user.email
email validation
phone
user.phone
phone number validation (convert
For the Custom field type, the behaviour and storage locations can be configured:
Parameter
Description
Store in object
The object in which the variable with the result of this field will be stored
Variable name
The name of the variable in which the result of this field will be stored
Textarea
When expected multiple lines
When "Don't allow to skip" is toggled off, the form can be canceled by a user by pressing the little close icon in the upper right corner of the form. When this happens, the system will place the tag form_canceled. When the form is not canceled the tag form_submitted is set. Use these tags to add actions to handle a canceled or submitted form.
Toggle when the form is mandatory and can't be skipped, see .
to action or not.
Out of the box you will find the form action to be implemented in the flow. There it is used to capture the contact details of the user.
On channels that are not web capable the form action will fall back to sequential actions. It will look like this for the example showed above.
