New Feature: Chat APIs

We now support a broad range of Chat JavaScript APIs in the Web Widget with the integrated Chat experience EAP, giving you advanced customization of the Chat experience and agent routing.

The naming of these APIs follows a new syntax as part of a broader Web Widget JavaScript APIs refresh, designed to scale more effectively as we grow our cross-product integrations. Some benefits of the new API syntax include simplicity, ease of maintenance, and future-proofing your code.

We have aliased the vast majority of the legacy $zopim.livechat APIs, so it will continue to work without the need to update any code. To see which APIs are planned or currently in-progress, please refer to our Web Widget developer API reference.

Please note, there are some cases where the mapping may result in subtle differences in how the APIs behave in the Web Widget compared to using $zopim.livechat previously. For example, we don’t have any separation between our launcher and window, so if you call `hide` or `setOffset` we apply it to the entire widget instead of just the launcher or window. Refer to the notes in Web Widget developer API reference for more detail.

If you intend to continue using the $zopim.livechat syntax for some time before migrating to the new zE syntax, please refer to this article to understand how to correctly wrap $zopim.livechat API calls when using zE.

If you previously signed up for the EAP, but indicated a need to wait for the APIs to be available, you should now receive an email to notify you that the EAP is enabled for your account.

There is a defect with the logout API and the team in Melbourne are working on resolving it now. Will update you when the fix has been released. If you need to use the API right now, would recommend opting out of the new experience until the issue is resolved.

We previously used $zopim.livechat.window.show(); to show the chat window on button click if chat is available, but now it triggers the main help search window and we dont want that - it confuses our customers.

can someone point me to how to trigger the chat window where users would initiate the live chat? i want it to open immediately instead of having to click "Help" > "Contact Us" (at the bottom where our users would miss it) > "Live Chat". I want it to expose "Live Chat" on button click.