Reference
Event Reference
Complete reference for all SDK events and platform webhook events.
SDK Events
| Event | Payload | Description |
|---|---|---|
ready | — | SDK fully initialized |
avatar:show | — | Avatar became visible |
avatar:hide | — | Avatar was hidden |
avatar:click | — | Visitor clicked the avatar |
avatar:stateChange | { state } | Animation state changed |
conversation:started | { conversationId } | Chat panel opened |
conversation:closed | { conversationId } | Chat panel closed |
message:sent | { message } | User sent a message |
message:streaming | { token } | Streaming response token |
message:received | { message } | Full response received |
guidance:started | { steps } | Guided tour started |
guidance:stepChanged | { step } | Guidance advanced to next step |
guidance:completed | — | Guided tour finished |
error | { error } | SDK error occurred |
Platform Events (Webhooks)
| Event | Description |
|---|---|
session.started | Visitor session started |
avatar.impression | Avatar viewed in viewport |
avatar.clicked | Avatar was clicked |
conversation.started | Conversation opened |
conversation.completed | Conversation closed successfully |
message.sent | Visitor message sent |
guidance.started | Guided tour started |
guidance.completed | Guided tour completed |
knowledge.sync.completed | Knowledge sync finished |
knowledge.sync.failed | Knowledge sync failed |