Marketplace icon

Webhook structure

Learn about Adyen's webhook structure.

In general, the body of a webhook contains the following objects.

Parameter Data type Description
data Object Object that contains information about the event.
environment String The environment where the transaction was processed—test or live.
type String The webhook type.

The information contained in the data object varies and depends on the webhook type. You can find the full schema for each type in API Explorer.

Below is an example request body for a webhook of type balancePlatform.accountHolder.created.

Example webhook request body
Expand view
Copy link to code block
Copy code
Copy code
{
"data": {
"balancePlatform": "YOUR_BALANCE_PLATFORM",
"accountHolder": {
"contactDetails": {
"address": {
"country": "NL",
"houseNumberOrName": "274",
"postalCode": "1020CD",
"street": "Brannan Street"
},
"email": "s.hopper@example.com",
"phone": {
"number": "+315551231234",
"type": "Mobile"
}
},
"description": "S.Hopper - Staff 123",
"id": "AH00000000000000000000001",
"status": "Active"
}
},
"environment": "test",
"type": "balancePlatform.accountHolder.created"
}

Next steps

Learn which webhooks are sent for different scenarios.