New Introducing Audio & Video Chat in Comm100 Live Chat. Read More>> ×

Reference for Webhook event: Chat Started

February 25th, 2016 | API & Webhooks

Comm100 Live Chat Webhooks support both HTTP and HTTPS URL. You will get the call back with the following properties when the Chat Started event occurs.

The data is in JSON format. Here is the introduction for JSON.

Here is an example of Chat Started event data

{
"event":"chat_started",
  "visitor":{
    "browser":"Google Chrome 29.0.1547.76",
    "chats":2,
    "city":"Vancouver",
    "company":"Comm100",
    "country":"Canada",
    "current_browsing":"https://www.comm100.com/",
    "custom_fields":[
      {
        "field_id":5000001,
        "name":"order_id",
        "value":"1780064"
      },
      {
        "field_id":5000002,
        "name":"bill_amount",
        "value":"500.00"
      }
    ],
    "custom_variable":[
      {
        "name":"user_login",
        "value":"facebook"
      },
      {
        "name":"have_sales",
        "value":"yes"
      }
    ],
    "department":"livechat",
    "email":"allon@comm100.com",
    "first_visit_time":"/Date(13584868423)/",
    "flash_version":"11.8.800.170",
    "id":1024768,
    "ip":"192.168.8.1",
    "keywords":"comm100",
    "landing_page":"https://www.comm100.com/livechat/",
    "language":"en_us",
    "name":"allon",
    "operating_system":"Windows 7",
    "page_views":3,
    "phone":"12983782710",
    "product_service":"livechat",
    "referrer_url":"http://www.google.com/q=comm100",
    "screen_resolution":"1440*900",
    "search_engine":"Google",
    "state":"British Columbia",
    "status":1,
    "time_zone":"UTC-08:00",
    "visit_time":"/Date(13584868542)/",
    "visits":5
  }
}

Visitor Properties

Id id of the visitor
name name of the visitor
email 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 Visitor Monitor. Custom fields contain the following properties:

id: id of the custom field
name : name of the custom field
value : value 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.
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
value : value 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

Related Articles