Skip to main content

Chat Transcripts

Visitor Chat uses Webhooks to notify customers when a new lead has been submitted. We make the POST request to the endpoint URL within a couple of minutes of the conversations closing.

Lead​

Sample Lead Request
{
  "lead": {
    "chat_id": "HsyHaLRcbGM2xZ9OMxN5qUaTxurQsBTe",
    "created_at": 1571734775,
    "last_message_at": 1571734787,
    "start_url": "https://testdomain.com/search_page.php?budgetswitch=0&make=&budgetmin=&budgetmax=&utm_source=google&utm_medium=cpc",
    "account": {
      "id": 123,
      "domain_name": "<domain name>",
      "department": {
        "id": 123,
        "name": "Lead"
      },
      "category": {
        // Null if category is not applicable.
        "id": 123,
        "name": "General Enquiry"
      }
    },
    "customer": {
      // Source can be of type "website", "sms", "whatsapp" or "facebook".
      "source": "website",
      "name": "Joe Bloggs",
      // null if not provided.
      "tel": "07777222222",
      // null if not provided.
      "email": "[email protected]",
      "browser_os": "Chrome 121 / Android 10"
    },
    "chat_transcript": [
      {
        "user_name": "Visitor",
        "message": "Hi...have you still got the grey mondeo for sale",
        "created_at": "1571734775"
      },
      {
        "user_name": "Emma",
        "message": "Hi there",
        "user_id": 20,
        "created_at": "1571734787"
      }
    ],
    // Any data that is supplied via VC_SETTINGS custom params.
    "page_data": [],
    "notes": "Any notes made by the operator",
    "analytics": {
      "footprints": [
        {
          "url": "http://testdomain.com/search_page.php?budgetswitch=0&make=25&model=235&budgetmin=&budgetmax=",
          "visited_at": 1571718264481
        },
        {
          "url": "http://testdomain.com/used-ford-mondeo-derby-derbyshire-2439913",
          "visited_at": 1571718281223
        },
        {
          "url": "http://testdomain.com/",
          "visited_at": 1571723066022
        },
      ],
      "source": "VisitorChat",
      "last_communication_time": 1571734787
    }
  }
}

Non-Lead​

Sample Non-Lead Request
{"non-lead": {
  "chat_id": "HsyHaLRcbGM2xZ9OMxN5qUaTxurQsBTe",
  "created_at": 1571734775,
  "last_message_at": 1571734787,
  "start_url": "https://testdomain.com/search_page.php?budgetswitch=0&make=&budgetmin=&budgetmax=&utm_source=google&utm_medium=cpc",
  "account": {
    "id": 123,
    "domain_name": "<domain name>",
    "department": {
      "id": null,
      "name": null
    },
    "category": {
      // Null if category is not applicable.
      "id": 123,
      "name": "General Enquiry"
    }
  },
  "customer": {
    // Source can be of type "website", "sms", "whatsapp" or "facebook".
    "source": "website",
    "browser_os": "Chrome 121 / Android 10"
  },
  "chat_transcript": [
    {
      "user_name": "Visitor",
      "message": "Hi...have you still got the grey mondeo for sale",
      "created_at": "1571734775"
    },
    {
      "user_name": "Emma",
      "message": "Hi there",
      "user_id": 20,
      "created_at": "1571734787"
    }
  ],
  // Any data that is supplied via VC_SETTINGS custom params.
  "page_data": [],
  "notes": "Any notes made by the operator",
  "analytics": {
    "footprints": [
      {
        "url": "http://testdomain.com/search_page.php?budgetswitch=0&make=25&model=235&budgetmin=&budgetmax=",
        "visited_at": 1571718264481
      },
      {
        "url": "http://testdomain.com/used-ford-mondeo-derby-derbyshire-2439913",
        "visited_at": 1571718281223
      },
      {
        "url": "http://testdomain.com/",
        "visited_at": 1571723066022
      },
    ],
    "source": "VisitorChat",
    "last_communication_time": 1571734787
  }
}
}