Step by Step Instructions  

You can use the Webhook option in the AI Agent's answer flow when setting up Topics and Events.  

To use Webhooks in the AI Agent's action flow, follow these steps:

1. Log in to the Comm100 Control Panel.
2. From the left navigation menu, go to AI & Automation > AI Agent > Topics / Events. If you have multiple AI Agents, make sure to choose the correct one from the drop-down list.
   
3. Go to the topic you want to edit, and scroll down to the Answers section.
4. Under the By Workflow tab, expand the Actions menu, scroll down to the Advanced section, and drag the Trigger a webhook action to the area.
   
5. On the Trigger a webhook action card, click Webhook Settings. The Webhook drawer appears.
   
6. On the Webhook drawer, complete the following settings based on your requirements:
   1. Choose the Post or Get method, and input the endpoint URL of the external service.
   2. If the Webhook endpoint requires authentication, turn on the Authorization Required toggle, and select the authorization credential. 
   3. Add webhook header.
   4. If you want to send content other than the default request body, add the Additional Post Body JSON. If you want to exclude the default pre-defined data in webhook body, turn on the Exclude predefined data in body toggle.
   5. Save Response to Variable. You can save the data from the endpoint’s response to the AI Agent’s variables, so that the data can be used as Dynamic Info in the AI Agent's workflow.
       
      

      For example, for the following Webhook response:

      { 

         "Name": "John", 

         "Country": France, 

       } 

      You can save the response key "Name" to variable "VisitorName" and response key "Country" to variable "VisitorCountry". The variables "VisitorName" with value “John” and "VisitorCountry" with value “France” are stored in the AI Agent’s database. They can then be used as Dynamic Info.

   6. Response Code to Action. 

7. Click OK.

Sample Data Sent to Your Web Application

By default, Comm100 sends the user-specific data to the designated webhook endpoint, such as web browsing behavior, pre-chat survey answers, and Ticketing & Messaging fields. This section shows a sample request sent to your application in a Live Chat interaction.  

Below is an example of the data in JSON format that will be sent to your server:
  {
    "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_variables":[
            {
            "name":"user_login",
            "value":"facebook"
            },
            {
            "name":"have_sales",
            "value":"yes"
            }
        ],
        "department":"livechat",
        "email":"allon@comm100.com",
        "first_visit_time":"/Date(13584868423)/",
        "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,
        "ssoId": ""
    },
    "FormValues": [
        {
            "label": "account",
            "value": "sam"
        },
        {
            "label": "password",
            "value": "1234"
        }
    ]
  }

Properties Explained

Visitor Status Description