Webhooks Data Structure
Here are some examples of the webhook payload that you may use to customize your server logic accordingly. The payload will be attached to the body of the POST request.
[
{
"created_ts": "2019-04-24T19:57:12.642Z",
"email": "email1@yahoo.com",
"email_count": 0,
"form_data": {},
"url": "https://yourdomain.net/"
},
{
"created_ts": "2019-04-25T18:34:12.642Z",
"email": "email2@gmail.com",
"email_count": 2,
"form_data": {},
"url": "https://yourdomain.net/contacts.html"
}
]
Each object in the array will represent a capture.
- created_ts: Represents when the capture entry was generated.
- email: If we were able to extract the email address from the abandoned form, it will be in here.
- email_count: If you're a subscriber of our Recover product, the number of emails sent out to the form abandoner will be shown here.
- form_data: Any other data that was abandoned will go in here. The formatting of this object will vary depending on how you structured your form and how it's configured.
- url: This is the url that the form was abandoned in.
Any field that you did not configure to be sent on the webhook will not exist in that specific payload. So if you did not mark the Form Data and the Email Count to be sent to you, it will simply omit the field like this.
[
{
"created_ts": "2019-04-24T19:57:12.642Z",
"email": "email1@yahoo.com",
"url": "https://yourdomain.net/"
},
{
"created_ts": "2019-04-25T18:34:12.642Z",
"email": "email2@gmail.com",
"url": "https://yourdomain.net/contacts.html"
}
]