Form messages are a type of structured message from Sunshine Conversations that allow you to capture user data in an ongoing conversation by displaying a form that can contain text inputs as well as select dropdowns.
For availability on devices and further details on the functionality from Sunshine Conversations side, check out this link.
Before you start
Before integrating a form into Ultimate though, you will need to create your form on Sunshine Conversations side. You can find information here on how to do this. Contact your CSM if you have any questions about this.
You will need the exact name of the form later on.
In this article we will cover:
Using Forms with Ultimate
Forms are a great way to collect customer data without having the bot ask multiple questions. Typical use cases include security, identification questions, or data change requests.
Once your form is created, go to your respective Dialogue that you would like to add the form and follow the below steps.
- Add a bot message with the shorthand code to capture the form and insert it. In the picture below we are adding our lead_capture form. However, you will add the name of your form in between template: and ))% in the snippet below.
Add a visitor message (Free Text Written) block right after the bot message. This captures the user's responses.
- Add another bot message block following the visitor message with some kind of acknowledgment of the customers' completion of the form, such as a thank you.
The user's answers are locked in the metadata. If you want to use them later in the chat, you will want to retrieve them - this is completely optional. We do this with Actions.
Get Conversationaction, select
<Metadata>, and complete the fields to save the answers from chat visitors to the session. In the Metadata Key, use the form fields name, as configured in your Sunshine Conversations template. Learn more about Sunshine Conversation Actions.
Sanitize Customer Responses
Sanitizing responses is something you will want to do if you are asking for any PII data from your customers. This is something you will be familiar with from Content Entities, for example, we by default sanitize email addresses and IBAN numbers. To understand more about Sanitizing check out the below articles.
How to sanitize form data
Depending on the use case you have for the forms, you may want to sanitize the information. This is easy to do.
- Click the blue bar where it says "if..." to open the details panel.
- Click the "Sanitize the user's answer" box to have the details hidden within Ultimate.
The result of this means that when you review the conversation within Ultimate, it will look as shown below.