Events

Name	Description	Data
ready	WebChatService is initialized and ready to accept commands.	n/a
restored	Chat session has been restored after page navigation or refresh.	n/a
restoreTimeout	Chat session restoration attempted was denied after user navigated away from originating website for longer than the time limit: default 60 seconds.	n/a
restoreFailed	Could not restore chat session after page navigation or refresh.	n/a
messageReceived	A new message has been received from the server. Includes text messages, status messages, notices, and other message types.	n/a
error	An error occurred between the client and the server.	(AJAX Response)
started	Chat session has successfully started.	n/a
ended	Chat session has successfully ended.	n/a
agentTypingStarted	Agents has started typing a new message.	n/a
agentTypingStopped	Agent has stopped typing.	n/a
pollingStarted	Chat server automatic polling has started.	n/a
pollingStopped	Chat server automatic polling has stopped.	n/a
clientConnected	Indicates the user has been connected to the chat session.	{message: (object), agents: (object), numAgentsConnected: (number)}
clientDisconnected	Indicates the user has been disconnected form the chat session.	{message: (object), agents: (object), numAgentsConnected: (number)}
agentConnected	Indicates an agent has connected to the chat.	{message: (object), agents: (object), numAgentsConnected: (number)}
agentDisconnected	Indicates an agent has disconnected from the chat.	{message: (object), agents: (object), numAgentsConnected: (number)}
supervisorConnected	Indicates a supervisor has connected to the chat.	{message: (object), agents: (object), numAgentsConnected: (number)}
supervisorDisconnected	Indicates a supervisor has disconnected from the chat.	{message: (object), agents: (object), numAgentsConnected: (number)}
clientTypingStarted	The user has started typing. Sends an event to the agent.	n/a
clientTypingStopped	After a user stops typing, a countdown begins. When the countdown completes, the typing notification will clear for the agent.	n/a