How Does It Work?
The webhook is fired whenever a new contact is added or an existing one is modified or deleted in the system. All the details of the new/updated contact (default and custom fields) are sent in a JSON-formatted payload to the API endpoint that you specify in the field.
If a default field of any contact is updated, the changed attribute information in the payload includes the field that was updated along with the date and time on which it was updated. However, if a custom field of any contact is updated, the changed attribute information in the payload includes only the date and time on which the field was updated.
Note: The webhook does not fire when you update the tags for the contacts.
The following is an example of the JSON payload that was sent after the default fields first_name and last_name were updated for a contact:
{
"subscriptions": [
{
"list_id": 1169,
"list": "Test_12312",
"status": "Hard-Bounced"
}
],
"changed_attributed": {
"first_name": "Friend",
"last_name": "",
"updated_at": "2020-07-22T16:34:02.000Z"
},
"contact": {
"1234": "abc",
"id": 12133221,
"account_id": 1000,
"email": "vidushi.sood123@hotmail.com",
"first_name": "Sam",
"last_name": "Jones",
"domain_name_id": 11,
"created_at": "2020-07-22T12:34:01.000-04:00",
"updated_at": "2020-10-08T10:40:17.000-04:00",
"age": null,
"language": "english",
"favourite_colour": null,
"vacation_spot": null,
"shirt_size": null,
"custom_field_001": false,
},
"tags": []
}
Setting Up the HTTP Post URL
The following are the steps for setting up the HTTP Post URL:
- Click your username on the top-right corner of the application and then from the drop-down menu, select Settings.
- On the Settings page, in the Connections section, click HTTP Post URL.
- On the HTTP Post URL page, enter the webhook API endpoint in the HTTP POST URL field.
- Click SAVE CHANGES.
