If you are moving from the Legacy Chat widget to the integrated live chat in Web Widget (Classic), you can expect to see some changes in your end users’ experiences, as well as your own widget configuration process.
The following features may have new options, or function differently, in Web Widget (Classic). Click the links to jump to a table or text describing the changes for each feature:
Minimized chat button launcher
The minimized chat button launcher appears on both desktop installations and mobile devices. The move to the integrated Chat experience may change the launcher’s appearance, placement, and label text.
If you want to make changes to the minimized chat button launcher beyond the general configuration options listed in the table below, you can build a custom launcher and use the Web Widget javascript APIs to control it as described in this tutorial.
Feature | Old Chat widget | Web Widget (Classic) default | Configuration options |
---|---|---|---|
Appearance (desktop) | Use the launcher API to customize the launcher label or build a custom launcher. |
||
Appearance (mobile) | Use the labelVisible API to make the label visible on both desktop and mobile launchers. |
||
Launcher placement | Fixed to the bottom of the browser window. | Floating. | Use the position
setting and offset
setting APIs to move the widget to the optimal placement. |
Label text | Customized text entry. | Select text from predefined strings in Support UI. | Use the chatLabel APIs to customize label text. |
Chat badge launcher
The chat badge launcher design is still available with integrated Chat if Chat is the only channel enabled in Web Widget (Classic). See Starting chats from the chat badge.
Chat appearance customizations
Several customization options previously available in the Appearance tab of the Chat dashboard will not be available with integrated Chat. These have been intentionally deprecated to remove outdated design elements and simplify the configuration options for customers.
Feature | Old Chat widget | Web Widget (Classic) default | Configuration options |
---|---|---|---|
Theme | Simple or Classic options | Simple theme only | See Advanced customization of Web Widget (Classic) for options. |
Window size | Customizable | Standard size only | See Advanced customization of Web Widget (Classic) for options. |
Mobile widget | Popout or overlay | Overlay only | See Advanced customization of Web Widget (Classic) for options. |
Message style | Speech bubble or simple lines | Simple lines only | See Advanced customization of Web Widget (Classic) for options. |
Draggable chat window
Users could drag the standalone Chat window around the web page. However, Web Widget (Classic) is not draggable. Instead, the popout feature is available.
Feature | Old Chat widget | Web Widget (Classic) default |
---|---|---|
Chat window mobility | Draggable by end user | Popout option opens widget in a new browser window |
Chat APIs
The majority of the $zopim.livechat APIs have been ported over to Web Widget (Classic) so you can continue to customize the Chat experience and route chats as before.
If you are already using the $zopim.livechat APIs, We have aliased the legacy $zopim.livechat syntax, so it will continue to work without the need to update any code.
Zendesk will eventually deprecate the old syntax, however this is not expected for at least 12 months. When we do, we will follow standard EOL procedure and provide customers with ample warning and communicate steps to mitigate impacts.
Legacy Chat APIs that will not be supported in the Web Widget (Classic) are listed here, including notes on reasoning why we have chosen not to support them going forward.
This table describes the Chat APIs that are immediately unavailable, the reason(s) why they are no longer supported, and your replacement alternatives.
Feature | Reason(s) | Configuration options |
---|---|---|
setNotes and appendNotes
|
Posed a security risk for customers. |
|
Cookie law APIs
The legacy standalone Chat widget provided two APIs relating to cookies, setDefaultImplicitConsent
and comply
.
We have mapped the integrated Chat cookies setting API to $zopim.livechat.cookieLaw.setDefaultImplicitConsent()
. This means that if you were previously using setDefaultImplicitConsent
to disable cookies, this will continue to work without the need to modify your code. To enable the use of cookies again ( i.e. the use of Chat), you will need to add code to call the updateSettings
API to allow cookies when the user accepts their use. You can find a code sample illustrating how this could work in the developer documentation here.
If you were using $zopim.livechat.cookieLaw.comply()
, this will not be mapped, and will not disable cookies with integrated Chat.
Setting languages
Language detection and setting for end users changes when moving from the Chat widget to Web Widget(Classic).
Feature | Old Chat widget | New integrated widget (default) | Configuration options |
---|---|---|---|
Language setting | Auto-detect based on page content and lang parameter in the page header, or manually set a specific language. | Language is automatically set by the user’s browser settings. | Use the setLocale API to override the visitor’s browser settings. |