Configuration
The settings panel has a few options to allow you to configure the webapp. Each webapp must have a name, and you can also add an optional description and logo. If needed, you can also link to your own terms and conditions as well.
General information about the channel
Optionally, add a logo and link to your terms and conditions
When a user arrives on the page, the chatbot welcomes them with a flow. It can be any flow, but by default it is the Default flow.
Any of your flows can be a Welcome flow
If you do not want a welcome interaction at all, create an empty flow and use that as the Welcome flow!
If you want your users to be able to quickly launch any of your flows, you can use the menu, by adding shortcuts to any of the existing flows. For each flow, you must define a label to make it easily recognizable by your users.
Define a menu for your users
This will show in the top-right corner in desktop mode
In mobile view, the applications menu will show at the bottom of the screen and slide up when activated:
You can launch a specific flow (and step) instead of the default Welcome Flow when loading the webapp by providing a
ref parameter in the webapp URL.There are two ways to use Ref parameters to redirect to flows. You can either configure them in the channel's settings page by adding connections between custom Ref parameters and a target flow:
Or you can use the following special syntax:
# will redirect to the step NAME_OF_STEP in the flow called NAME_OF_FLOW
https://chat.csml.dev/s/abc12345678901234?ref=target:[email protected]_OF_FLOW
# or, if no step is provided, the `start` step will be used
https://chat.csml.dev/s/abc12345678901234?ref=target:NAME_OF_FLOW
The main advantage of the second syntax is that you can generate the links on the go; however, the first method is more flexible as you can easily change where a link is redirected even after it is created, and the content of the Ref parameter is entirely customizable.
The autocomplete feature helps your chatbot provide a list of up to 5 items that are contextualized to what the user is currently typing. Think of it as quickly hitting one of the first google search results!
To configure Autocomplete, you need to have a backend endpoint that will handle the requests and respond accordingly. You can configure this endpoint in the webapp's configuration panel:
The request that will be performed by the webapp will be as follows:
curl -X "POST" "https://my.example.com/autocomplete?token=some-auth-token" \
-H 'Content-Type: application/json;charset=utf-8' \
-d $'{"text": "Give me the best result"}'
Your endpoint must return results within 5 seconds as an
application/json content-type, formatted as an array of maximum 5 results containing a title, optional highlighting matches, and the corresponding payload. [
{
"title": "What is the best result?",
"matches": {
"highlights": [
{
"word": "What",
"highlight": false
},
{
"word": "is",
"highlight": false
},
{
"word": "the",
"highlight": false
},
{
"word": "best",
"highlight": true
},
{
"word": "result",
"highlight": true
},
{
"word": "?",
"highlight": false
}
],
"text": "What is the best result?",
"has_highlights": true
},
"payload": "RESULT_ONE_PAYLOAD"
},
{
"title": "Another good result",
"matches": {
"highlights": [
{
"word": "Another",
"highlight": false
},
{
"word": "good",
"highlight": false
},
{
"word": "result",
"highlight": true
}
],
"text": "Another nice result",
"has_highlights": true
},
"payload": "ANOTHER_RESULT_PAYLOAD"
}
]
When a user selects a result, it will behave as a button click where the text is displayed and the payload is sent to the chatbot.
If an autocomplete endpoint is set, it will be enabled by default. However, it can be disabled or reenabled dynamically in your CSML script:
say Autocomplete(false)
say Autocomplete(true)
Autocomplete status is not persisted across page reloads. When reloading the page, this will always be set to
true by default!Last modified 1yr ago