Skip to contentSkip to navigationSkip to topbar
On this page

Migrate to Webchat 3.x.x (public beta)


(information)

Public Beta

Flex Webchat 3.x.x 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.

(information)

Info

Not a HIPAA Eligible Service
Webchat 3.x.x is not a HIPAA Eligible Service and should not be used in workflows that are subject to HIPAA.

This page describes the differences between Webchat 3.x.x and other Flex webchat versions, as well as how to migrate to Webchat 3.x.x from another webchat version.

Previously, Flex released Flex Webchat 2.0 and the Webchat React App. You can continue using your existing webchat or migrate to Webchat 3.x.x.


Webchat app comparison

webchat-app-comparison page anchor
Webchat 3.x.xWebchat React AppWebchat 2.0
Best for organizations thatAre setting up webchat for the first time in Flex UI 2.x.x or later

Use Webchat 2.0 and want to migrate for additional security features
Want to fully customize webchat and have development resources to build, deploy, and host itUse legacy messaging
Works withFlex UI 2.x.xFlex UI 2.x.x and 1.x.xFlex UI 2.x.x and 1.x.x
App typeFlex nativeOpen-sourceFlex native
Hosted by TwilioYesNoYes
Built on…Twilio ConversationsTwilio ConversationsProgrammable Chat(legacy messaging)
Auto-generated embed code to add webchat to your websiteYesNoYes
Shields account information with a deployment keyYesNoNo
Uses fingerprinting for enhanced securityYesNoNo
Chat attachments availableYesYesYes, if enabled
Requires development effort to buildNoYesNo
Ability to include configurable pre-engagement formYesYesYes
Ability to change the theme, style, and brand of webchatNo. You can change to light or dark mode only.YesYes

If you're currently using Webchat 2.0

if-youre-currently-using-webchat-20 page anchor

You can continue using WebChat 2.0 as long as legacy messaging is supported. However, you may want to upgrade to Webchat 3.x.x. Webchat 3.x.x is built on Conversations and includes enhanced security features.

If you are using Flex UI 1.x.x, you must upgrade to Flex UI 2.x.x before you can use Webchat 3.x.x.

To migrate to Webchat 3.x.x:

  1. Follow the instructions to set up a new Webchat 3.x.x widget.
    • When setting up your pre-engagement form, you must re-create your form in Webchat 3.0, rather than copying and pasting your Webchat 2.0 pre-engagement form. Because there are so many changes between the two versions, this will save you time.
    • In Webchat 3.1.0 and later, the pre-engagement form is enabled by default. For information about how to configure it or turn it off, see Configure a pre-engagement form and context.
  2. In Step 4: Embed the webchat widget on your website, delete your Webchat 2.0 embed code and replace it with Webchat 3.x.x embed code.

You'll also want to be aware of the following additional differences between Webchat 2.0 and Webchat 3.x.x:

  • We have updated the name of the pre-engagement form attributes that control the text at the top of your pre-engagement form:
    • title: Name or greeting that appears as the heading at the top of the form.
    • description: Introductory text for the form that appears below the title.
  • The CheckboxItem field type is now available, which enables you to include checkboxes in your forms. The checkbox can include accompanying plain or HTML-formatted text, including links.
  • The new pattern field attribute is now available. This attribute enables you to add custom validation to your fields.

If you're currently using the Webchat React App

if-youre-currently-using-the-webchat-react-app page anchor

If you're using the Webchat React App, you can continue to use your existing webchat or migrate to Webchat 3.x.x. However, the Webchat React App is no longer maintained by Twilio. You may want to migrate to Webchat 3.x.x if you'd like a solution that doesn't require development effort to build or maintain, is hosted by Twilio Flex, and includes enhanced security features.

To migrate to Webchat 3.x.x:

  1. Follow the instructions to set up a new Webchat 3.x.x widget to create new chat addresses that are linked to deployment keys.
  2. Update your website to remove your existing Webchat React App deployment and add the embed code for the Webchat 3.x.x widget.

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.