{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/webhooks/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Available event types and payloads","description":"Start building with the Dixa API","siteUrl":"https://docs.dixa.io/","keywords":"dixa developer hub, api portal starter, api reference docs","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"available-event-types-and-payloads","__idx":0},"children":["Available event types and payloads"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The events that you can subscribe to provide a holistic overview of the full conversation life cycle in Dixa:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#created"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation created"]}]},": a conversation is created inside Dixa"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#custom-attribute-updated"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation custom attribute updated"]}]},": custom attributes of a conversation are updated"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#open"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation open"]}]},": a conversation is reopened (after it was closed)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#pending"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation pending"]}]},": a follow-up is added to a conversation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#pending-expired"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation pending expired"]}]},": a follow-up added to the conversation has expired"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#closed"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation closed"]}]},": a conversation gets closed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#abandoned"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation abandoned"]}]},": a conversation is closed without having an agent assigned"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#enqueued"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation enqueued"]}]},": a conversation enters a queue in Dixa"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#assigned"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation assigned"]}]},": a conversation gets assigned to an agent"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#unassigned"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation unassigned"]}]},": a conversation gets unassigned from an agent"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#note-added"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation note added"]}]},": an internal note is added to a conversation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#message-added"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation message added"]}]},": a message is added to the conversation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#tag-added"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation tag added"]}]},": a tag is added to the conversation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#tag-removed"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation tag removed"]}]},": a tag is removed from a conversation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#rated"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation rated"]}]},": a conversation is rated by the end-user OR a comment concerning the rating is left by the end-user (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["NOTE"]},": one webhook is fired for each rating event or rating comment.)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#transferred-to-agent"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation transferred to agent"]}]},": a conversation is transferred to an agent"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#transferred-to-queue"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversation transferred to queue"]}]},": a conversation is transferred to a queue"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#banned-enduser"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Banned enduser"]}]},": an end user is banned"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#unbanned-enduser"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Unbanned enduser"]}]},": an end user ban is removed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#banned-ip"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Banned ip"]}]},": an IP address is banned"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#unbanned-ip"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Unbanned ip"]}]},": an IP address ban is removed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#end-user-replaced"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enduser replaced"]}]},": the end user of a conversation is updated"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#typing-started"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typing started"]}]},": The agent is typing a message to the end-user"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#sla-pending"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SLA pending"]}]},": an SLA evaluation is created for a conversation, awaiting outcome"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#sla-breached"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SLA breached"]}]},": a conversation has exceeded the SLA deadline"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#sla-achieved"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SLA achieved"]}]},": a conversation has met the SLA target"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads#sla-voided"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SLA voided"]}]},": an SLA evaluation is no longer applicable for a conversation"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each webhook will have a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/webhooks/webhooks-payloads"},"children":["dynamic payload"]},", as not all information is equally important for all events."," ","This means that we adjust the data depending on what event you have subscribed to, giving you a better overview and making it easier to receive the right information."," ","You can see the payload of the latest webhooks you received in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Integrations"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Webhooks"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["View"]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["View payload"]},"."]}]},"headings":[{"value":"Available event types and payloads","id":"available-event-types-and-payloads","depth":1}],"frontmatter":{"seo":{"title":"Available event types and payloads"}},"lastModified":"2026-04-09T11:32:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/webhooks/webhooks-events","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}