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.

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.

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.

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.