Embedded Service Chat for Web Developer Guide

Embedded Service Chat for Web Developer Guide
Adjust General Parameters
Change the Embedded Chat Window Appearance and Behavior
Customize Embedded Chat
Expand the Pre-Chat Stage
Boost Chat Stage
Embedded Chat Custom Events
Create Custom Chat Events
Add Special APIs
Customize the Channel Menu
Embedded Service Customized Components
Code Snippet Versions
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Embedded Chat Custom Events

There are three APIs that let you create custom chat events with Embedded Chat. Available using Embedded Service code snippet version 5.0 and later.

The legacy chat product is in maintenance-only mode, and we won't continue to build new features. You can continue to use it, but we no longer recommend that you implement new chat channels. Instead, you can modernize your customer communication with Messaging for In-App and Web. Messaging offers many of the chat features that you love plus asynchronous conversations that can be picked back up at any time.

Important

embedded_svc.liveagentAPI.sendCustomEvent()

Sends a custom event to the agent console of the agent currently chatting with a customer.

Table 1. Arguments
Name Type Description
type string The name of the custom event to send to the agent console.
data string Extra data you want to send to the agent console along with the custom event.

embedded_svc.liveagentAPI.getCustomEvents()

Retrieves a list of custom events from both the agent and chat visitor that are received during this chat session.

Table 2. Arguments
Name Type Description
callback function JavaScript method called upon completion of the method. It passes a JSON formatted string of the events.

embedded_svc.liveagentAPI.addCustomEventListener()

Registers a function to call when a custom event is received in the chat window.

Table 3. Arguments
Name Type Description
type string The type of custom event you want to listen for.
callback function .JavaScript method called upon completion of the method. It passes an object that has two attributes: type and data.