WebChat Events

webchat.lead.created

Triggered when a new lead is captured via WebChat.

{
  "apiVersion": "2021-08-23",
  "type": "webchat.lead.created",
  "data": {
    "firstName": "John",
    "lastName": "Smith",
    "phoneNumber": "+19995550000",
    "campaignId": "29OBdh8BLaEmx5Sj8XeLfKgsuh7",
    "timestamp": "2021-10-14T11:41:00.560061"
  },
  "customData": {
    "myKey": "myValue"
  }
}

Field	Type	Description
apiVersion	string	API version (currently 2021-08-23)
type	string	The event type
data.campaignId	string	WebChat campaign ID
data.phoneNumber	string	E.164 formatted phone number
data.timestamp	string	ISO 8601 timestamp of when the lead was acquired
data.firstName	string?	Lead's first name, if captured
data.lastName	string?	Lead's last name, if captured
customData	object?	Custom key-value pairs, if configured (see Custom Data)