Omni-Widget Webhook
- SUPPORT
Omni-Widget Webhooks are HTTP(S) callbacks that occur when a certain web chat event takes place. Webhooks enable you to extend the capabilities of WebChat. For example, you can record chats in your own system by utilizing Omni-Widget Webhooks. Best of all, setting up Omni-Widget Webhooks is easy.
Event example Data Sent to Your Server
Offline message is submitted
{
"event":"OfflineMessageSubmit",
"planId":"7b6115bf-82e4-46c2-bbe9-22e79cd20b94",
"offlineMessageId":"67b521ed-551d-497a-9b77-926328700708",
"visitorId":"32bbad20-2216-4159-9949-584a6d91e5b4",
"sessionId":"3c32fbfe-d1f8-4968-95bf-124c218d1906",
"content":"Hi, I need help"
}Fields | Description |
event | Triggered events |
offlineMessageId | Unique offline message ID |
planId | Unique Ominiwidget ID |
visitorId | Unique visitor ID |
sessionId | Unique Webchat session ID |
content | Message content submitted by the visitor |
Chat starts
{
"event":"LiveChatSessionChatting",
"planId":"7b6115bf-82e4-46c2-bbe9-22e79cd20b94",
"sessionId":"80f9227b-9e77-4ca1-a3c8-5c4ea0c95660",
"visitorId":"32bbad20-2216-4159-9949-584a6d91e5b4"
}Fields | Description |
event | Triggered events |
planId | Unique Ominiwidget ID |
sessionId | Unique Webchat session ID |
visitorId | Unique visitor ID |
Chat ends
{
"event":"LiveChatSessionEnd",
"planId":"7b6115bf-82e4-46c2-bbe9-22e79cd20b94",
"sessionId":"80f9227b-9e77-4ca1-a3c8-5c4ea0c95660",
"visitorId":"32bbad20-2216-4159-9949-584a6d91e5b4"
}Chat is wrapped up
{
"event":"LiveChatSessionWrapUp",
"planId":"7b6115bf-82e4-46c2-bbe9-22e79cd20b94",
"wrapUpId":"b75084c5-bbf5-4de1-a76b-79a218ef8f87",
"visitorId":"32bbad20-2216-4159-9949-584a6d91e5b4",
"sessionId":"80f9227b-9e77-4ca1-a3c8-5c4ea0c95660",
"category":"Inquiry",
"comment":"Inquire about the order"
}Fields | Description |
event | Triggered events |
wrapUpId | Unique Wrap-up ID |
visitorId | Unique visitor ID |
sessionId | Unique Webchat session ID |
category | The Warp-up category |
comment | The Warp-up comment |
Chat is transferred
{
"event":"LiveChatSessionTransfer",
"planId":"7b6115bf-82e4-46c2-bbe9-22e79cd20b94",
"transferId":"4ec9ee5d-3ee1-4a20-b678-8e28f6a82b23",
"visitorId":"32bbad20-2216-4159-9949-584a6d91e5b4",
"sessionId":"816147fa-ef5c-4491-890c-b73d3be1ee2b"
}Fields | Description |
event | Triggered events |
planId | Unique Ominiwidget ID |
transferId | Unique transfer ID |
visitorId | Unique visitor ID |
sessionId | Unique Webchatsession ID |
Agent status changes
{
"event":"UserPresenceChanged",
"agentId":"67cb1332-6e0a-480c-b675-bd73cf0d597d",
"presence":"Away",
"presenceId":"cae99a62-6276-40ce-aae7-618ab613a9ae"
}Fields | Description |
event | Triggered events |
AgentId | Unique Agent ID |
Presence | The current status of the agent |
PresenceId | The unique ID of the status |
Add Omini-Widget webhooks
Login to your CloudCX Control Panel.
Click Apps&Intergrations.
Go to the Webhooks card and click Settings.
Click create Omni-Widget webhook
Select which widgets to apply to, or you can choose to apply to all widgets.
Choose the Event type and provide the URL to which the event data will be sent.
Click Save.