Datastructure

Datastructure

Beneath the event type that triggers a webhook and the URL of the webhook, a webhook object also contains the URL parameters that are attached as well as a body specification, which will be sent as JSON. For returned webhooks also the ID of the webhook is submitted.
Valid event types:
– doi Triggered when a contact acknowledges the doi permission with the doi link
– unsubscription Triggered when a contact unsubscribed
– bounce
Triggered when a bounce is registered
– filtered Triggered when a personalization error occurs while sending a mailing
In the following example you can see how to use standard and custom fields as well as constants (keyword “customValue”).

Example:

{
"event": "doi",
"url": "http://xqueue.com/webhook",
"bodySpec": {
"customFields": [
44
],
"standardFields": [
"email",
"gender",
"country",
"firstname"
]
},
"urlParams": [
{
"name": "email",
"standardContactField": "email"
},
{
"name": "name",
"standardContactField": "firstname"
},
{
"customContactField": 44,
"name": "cust1"
},
{
"customValue": "testConst",
"name": "const"
}
]
}

Example 2: Create a webhook that informs about personalization errors

{
"event": "filtered",
"url": "http://xqueue.com/webhook",
"urlParams": [
{
"name": "email",
"standardContactField": "email"
}
],
"bodySpec": {
"eventFields": [
"cause",
"timestamp"
]
}
}