Events
| Name | Description | Data |
|---|---|---|
| ready | WebChatService is initialized and ready to accept commands | |
| restored | Chat session has been restored after page navigation or refresh | |
| restoreTimeout | Chat session restoration attempted was denied after user navigated away from originating website for longer than the time limit: default 60 seconds. | |
| restoreFailed | Could not restore chat session after page navigation or refresh | |
| messageReceived | A new message has been received from the server. Includes text messages, status messages, notices, and other message types | |
| error | An error occurred between the client and the server | (AJAX Response) |
| started | Chat session has successfully started | |
| ended | Chat session has successfully ended | |
| agentTypingStarted | Agents has started typing a new message | |
| agentTypingStopped | Agent has stopped typing | |
| pollingStarted | Chat server automatic polling has started | |
| pollingStopped | Chat server automatic polling has stopped | |
| 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. | |
| clientTypingStopped | After a user stops typing, a countdown begins. When the countdown completes, the typing notification will clear for the agent. |
Comments or questions about this documentation? Contact us for support!
