Event object structure
The event object structure is unified and is the same for all of event types, except for ready event.
A typical event object looks as follows:
{
"conversationId": "jp3r7k2ngren",
"templateId": "63eyk7x6ynvj",
"lead": {
"name": "Kurt Russell",
"email": "test@example.com",
"phone": "+1234567890",
"company": "Acme"
},
"teamMember": {
"id": "k98rezxkyepm",
"name": "John Smith"
},
"companyId": "463eykw6ynvj",
"message": "When suits you for a demo?",
"response": "Wednesday 29th August at 7:30am",
"widget": {
"sidebarOpen": true,
"isOnline": true,
"widgetVisible": true
},
"appointment": {
"timeUTC": "2018-08-29T06:30:00+00:00",
"leadTimezone": "Europe/London",
"companyTimezone": "Europe/Amsterdam",
"duration": 30
}
}
For the fields that we don’t have information for, ‘ null’ will be specified.
For example, for a lead where we do not know their phone, name or company there will be an event object:
<code>"lead": {
"name": null,
"email": "test@example.com",
"phone": null,
"company": null
},
Those fields will be filled when appropriate events fire, i.e. if phoneCapture event is fired, phone field will be filled:
"lead": {
"name": null,
"email": "test@example.com",
"phone":”+1234567890”,
"company": null
},