You can register to a set of various events that occur within the Webchat, from data flows like "a message was received from Cognigy" to interactions like "the webchat was closed".
To do that, use the webchat.registerAnalyticsService function to execute a callback when events occur:
webchat.registerAnalyticsService(event => {
// react to the event that ocurred
});If you e.g. want to react to incoming messages from Cognigy, you can do it like this:
webchat.registerAnalyticsService(event => {
if (event.type === "webchat/incoming-message") {
console.log("incoming message: " + event.payload.text);
}
});Anytime an event is being emitted within the Webchat, it will cause the passed callback function to be executed.
The event object will always have a type property and may have a payload property depending on the event.
By checking for event.type, you can filter events for the ones you are interested in.
If you e.g. want to end session when user closes the webchat widget, you can do it like this:
webchat.registerAnalyticsService(event => {
if (event.type === "webchat/close") {
webchat.endSession();
}
});This will end the current session and clear any messages from the session.
| Type | Payload | Description |
|---|---|---|
webchat/open |
- | The webchat was opened |
webchat/close |
- | The webchat was closed |
webchat/minimize |
- | The webchat was minimized |
webchat/switch-session |
sessionId |
The session was switched |
webchat/incoming-message |
{ text, data } |
A message was received from Cognigy |
webchat/outgoing-message |
{ text, data } |
A message was sent to Cognigy |
plugin/messenger/action |
Object |
An action was triggered from a Webchat or Messenger Template |
See it in action:
