Comm100 Live Chat Webhooks support both HTTP and HTTPS URLs. You will get the call back with the following properties when the Chat Ended event occurs.
The data is in JSON format. Here is the introduction of JSON.
Here is an example of Chat Ended event data
{
"event": "chat_ended",
"visitor": {
"browser": "Google Chrome 80.0.3987.132",
"chat_id": "16c2cc3a-1b15-4b4f-9298-1cd04d6cec15",
"chats": 8,
"city": "Toronto",
"company": "",
"country": "Canada",
"current_browsing": "https://dash11.comm100.io/frontEnd/assets/livechat/previewpage/?campaignId=c9e91d04-3774-4470-b84d-6bc00874fe9d&siteId=10100116&q=1618890066662",
"custom_fields": [],
"custom_variables": [
{
"name": "Name",
"value": ""
}
],
"department": "c47c5e3a-0a3b-4aa5-98ea-cec0ae5ab7b9",
"skill": "3d68dc80-9c67-455b-abfe-1b7ac55fac98",
"email": "test@email.com",
"first_visit_time": "/Date(1580361387156)/",
"flash_version": "",
"id": "e2bafca0-efe5-45a7-96ae-a7e3b8d7c410",
"ip": "196.247.57.19",
"keywords": "",
"landing_page": "https://dash11.comm100.io/frontEnd/assets/livechat/previewpage/?campaignId=c9e91d04-3774-4470-b84d-6bc00874fe9d&siteId=10100116&q=1618890066662",
"language": "en-US",
"name": "testName",
"operating_system": "Windows 10",
"page_views": 1,
"phone": "",
"product_service": "",
"referrer_url": "https://dash11.comm100.io/livechat/agentconsole.aspx?siteid=10100116&v=10.0.8",
"screen_resolution": "1536x864",
"search_engine": "",
"state": "Ontario",
"status": 9,
"time_zone": "GMT -08:00",
"visit_time": "/Date(1584415749307)/",
"visits": 7
},
"chat": {
"attachment": [],
"chat_transcript": "Agent Walid has joined the chat.⊙[03:30:01] Walid: testName thank you for contacting us! How may I help you?⊙It's been a while since your last response. Please respond within the next few minutes or this chat will be ended.⊙The visitor has left the chat.⊙The chat is ended.(03:36:59)⊙",
"company": "",
"custom_fields": [],
"custom_variable": [
{
"name": "Name",
"value": ""
}
],
"department": "Support",
"email": "test@email.com",
"end_time": "/Date(1584416219323)/",
"id": "16c2cc3a-1b15-4b4f-9298-1cd04d6cec15",
"name": "testName",
"note_attachment": [],
"operator_comment": "",
"operators": [
{
"display_name": "Walid",
"email": "walidr3157@gmail.com",
"id": 1
}
],
"phone": "",
"product_service": "",
"rating": "-1",
"rating_comment": "",
"start_time": "/Date(1584415801019)/",
"waiting_time": "0s ",
"wrap_up": {
"category": "",
"comment": "",
"fields": [],
"time": "/Date(1584416219323)/"
}
}
}
Visitor Properties
| Id | id of the visitor |
| name | name of the visitor |
| email of the visitor | |
| status | status of the visitor (Please check the Visitor Status Description at the bottom of this article) |
| phone | phone of the visitor |
| company | company of the visitor |
| first_visit_time | time the visitor first visited a web page pasted with Comm100 Live Chat code |
| visit_time | starting time when this visitor visits your website this time |
| city | city of the visitor |
| state | state of the visitor |
| country | country of the visitor |
| ip | ip of the visitor |
| language | language the visitor is using |
| screen_resolution | screen resolution of the visitor’s device |
| time_zone | time zone of the visitor |
| flash_version | flash version of the browser the visitor is using |
| operating_system | operating system of the visitor’s device |
| browser | browser the visitor is using |
| custom_fields | values of custom fields entered by visitors in the pre-chat window. Agents can also update the value(s) during chat in Agent Console. Custom fields contain the following properties: id: id of the custom field |
| product_service | product/service the visitor selected in the pre-chat window. Agents can also update the value while chatting with visitors. |
| department | department the visitor selected in the pre-chat window. Agents can also update the value while chatting with visitors. |
| skill | skill of an agent that determines their suitability to handle a chat request |
| custom_variable | information of custom variables captured from the web page visitors viewed. Custom variables contain the following properties: name : name of the custom variable |
| current_browsing | page the visitor is currently looking at |
| visits | total times of visits a visitor has made on your website from the first time to present |
| chats | total times of chats a visitor has made on your website from the first time to present |
| referrer_url | URL of the page from which a visitor comes to your website |
| search_engine | search engine the visitor used to search for your website |
| keywords | keywords the visitor used to search for your website |
| landing_page | title and URL of the first page of your website the visitor visited |
| page_views | total number of web pages the visitor viewed on your website |
Visitor Status Description
| 0 | waiting for chat |
| 1 | voice chatting |
| 2 | chatting |
| 3 | pre-Chat |
| 4 | manually Invited |
| 5 | auto invited |
| 6 | offline message |
| 7 | refused by agent |
| 8 | refused by visitor |
| 9 | chat ended |
| 10 | in site |
| 11 | out of site |
Chat Properties
| Id | id of the chat |
| name | name of the visitor |
| email of the visitor | |
| phone | phone of the visitor |
| product_service | product/service the visitor selected in the pre-chat window. Agents can also update the value while chatting with visitors. |
| department | department the visitor selected in the pre-chat window. Agents can also update the value while chatting with visitors. |
| operators | operators that participate in the chat, separated by comma |
| custom_fields | values of custom fields entered by visitors in the pre-chat window. Agents can also update the value(s) during chat in Agent Console. Custom fields contain the following properties: id: id of the custom field |
| custom_variable | information of custom variables captured from the web page visitors viewed. Custom variables contain the following properties: name : name of the custom variable |
| start_time | time when the chat started |
| waiting_time | amount of time a visitor has been waiting before his/her chat request was accepted |
| end_time | time when the chat ended |
| chat_transcript | content of the chat |
| attachments | files the agent send to the visitor or vice versa as well as the screenshots sent to the agent by the visitor through Comm100 Screen Capture. Attachments contain the following properties: name – name of the attachment |
| rating | rating on the agents submitted by the visitor |
| rating_comment | comment on agents’ customer service submitted by the visitor |
| operator_comment | notes added for this chat by the agent |