Flex Webchat 3.0 is currently available as a Public Beta product and the information contained in this document is subject to change. This means that some features are not yet implemented and others may be changed before the product is declared as Generally Available. Public Beta products are not covered by a Twilio SLA.
Not a HIPAA Eligible Service
Webchat 3.0 is not a HIPAA Eligible Service and should not be used in workflows that are subject to HIPAA.
This page applies to Webchat 3.0. If you are using Webchat 2.0, see Webchat 2.0 installation information instead.
To set up Webchat 3.0, you need to create a deployment key, link the deployment key to a chat address, and add the Flex-generated embed code to your website. This page provides detailed instructions.
You can have multiple deployment keys for different use cases. For example, if you have multiple brands with different domains, you can have a separate webchat widget for each brand.
Use the following steps to set up Webchat 3.0:
In some environments, one deployment key is already set up for you and connected to a messaging address. If your environment includes a default deployment key and you'd like to use it, skip to Step 3: Test your webchat flow.
Otherwise, complete the following steps to create a deployment key:
Enter the following information:
https://demo.flex.twilio.com
, which enables you to use Webchat 3.0 in the Flex demo environment.
Enter the following information:
<div id="twilio-webchat-widget-root"></div>
There are two things you can customize for Webchat 3.0:
theme.isLight
: Control whether webchat uses light mode or dark mode.
appStatus
: Control whether the webchat widget is open by default.
By default, file attachments are enabled in Webchat 3.0. For details about attachments in Webchat 3.0, see File Attachments and API Limits.
You can restrict chat attachment file size and file types. For details, see "How do I update my file attachment configuration for Flex Conversations?" in Conversations FAQ and Troubleshooting.
Because Webchat 3.0 is built on Twilio Conversations, you can change orchestration and messaging flows with the Interactions API.
After you create your deployment key, you can update its settings. From Twilio Console, navigate to Flex > Manage > Webchat and click the edit icon for your deployment key.
If you need to update Allowed origins or Fingerprint sensitivity, you may want to do so outside of normal business hours. When you change these settings, any existing webchat conversations might be disconnected.
You cannot change the deployment key SID or address configuration SID. If you need to change these, see the steps to replace the deployment key for an existing webchat widget.
If your deployment key is compromised, complete the following steps: