---
title: "Webhook structure and types for payouts"
description: "Learn which webhook types are sent for each event."
url: "https://docs.adyen.com/payouts/payout-service/webhook-types"
source_url: "https://docs.adyen.com/payouts/payout-service/webhook-types.md"
canonical: "https://docs.adyen.com/payouts/payout-service/webhook-types"
last_modified: "2020-03-16T15:03:00+01:00"
language: "en"
---

# Webhook structure and types for payouts

Learn which webhook types are sent for each event.

[View source](/payouts/payout-service/webhook-types.md)

On this page, you'll find information about:

* The general [webhook structure](#webhook-structure).
* The [types of webhooks](#type).

You'll also learn about which webhook types are sent based on which event.

## 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](#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](https://docs.adyen.com/api-explorer/balanceplatform-webhooks/latest/overview).

Below is an example request body for a webhook of `type` [balancePlatform.accountHolder.created](https://docs.adyen.com/api-explorer/#/balanceplatform-webhooks/latest/post/balancePlatform.accountHolder.created).

**Example webhook request body**

```json
{
  "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"
}
```

## Webhook types

Webhooks are typically sent when:

* A resource was created or updated.
* A request was initiated (such as a payment authorisation request, a refund request, or a funds transfer request).
* There was a funds movement (funds added to or deducted from balance accounts).

You can differentiate the events based on the `type`. Some webhook types also include a `data.status` field that informs you of the outcome of the event.

### Configuration webhooks

Configuration webhooks inform your system about events that occur with account holders, balance accounts, and payment instruments.

| Type                                                                                                                                                                  | Description                                                                                                                   |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| [balancePlatform.accountHolder.created](https://docs.adyen.com/api-explorer/#/balanceplatform-webhooks/latest/post/balancePlatform.accountHolder.created)             | An [account holder](/payouts/payout-service/account-structure-resources#balance-platform-resources) was successfully created. |
| [balancePlatform.accountHolder.updated](https://docs.adyen.com/api-explorer/#/balanceplatform-webhooks/latest/post/balancePlatform.accountHolder.updated)             | An account holder was successfully updated.                                                                                   |
| [balancePlatform.balanceAccount.created](https://docs.adyen.com/api-explorer/#/balanceplatform-webhooks/latest/post/balancePlatform.balanceAccount.created)           | A [balance account](/payouts/payout-service/account-structure-resources#balance-platform-resources) was successfully created. |
| [balancePlatform.balanceAccount.updated](https://docs.adyen.com/api-explorer/balanceplatform-webhooks/latest/post/balancePlatform.balanceAccount.updated)             | A balance account was successfully updated.                                                                                   |
| [balancePlatform.balanceAccountSweep.created](https://docs.adyen.com/api-explorer/#/balanceplatform-webhooks/latest/post/balancePlatform.balanceAccountSweep.created) | A [balance account sweep](/payouts/payout-service/internal-fund-transfers/scheduled-fund-transfers) was successfully created. |
| [balancePlatform.balanceAccountSweep.deleted](https://docs.adyen.com/api-explorer/balanceplatform-webhooks/latest/post/balancePlatform.balanceAccountSweep.deleted)   | A balance account sweep was successfully deleted.                                                                             |
| [balancePlatform.balanceAccountSweep.updated](https://docs.adyen.com/api-explorer/#/balanceplatform-webhooks/latest/post/balancePlatform.balanceAccountSweep.updated) | A balance account sweep was successfully updated.                                                                             |

### Transfer webhooks

Transfer webhooks inform your system about incoming and outgoing transfers in your platform.

| Type                                                                                                                                   | Description                                                                                                                                                                                                                          |
| -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [balancePlatform.transfer.created](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/post/balancePlatform.transfer.created) | A transfer request was created to credit funds to or deduct funds from a balance account in your platform. The content informs you of the [event that triggered the transfer request](#transfer-event), such as a payment or refund. |
| [balancePlatform.transfer.updated](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/post/balancePlatform.transfer.updated) | A transfer request's status changed.                                                                                                                                                                                                 |

[]()\
You can identify transfer webhooks sent for different events by checking the following parameters and values:

|                                                                                                 | [category](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/post/balancePlatform.transfer.created#request-data-category) | [type](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/post/balancePlatform.transfer.created#request-data-type) | [counterparty](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/post/balancePlatform.transfer.updated#request-data-counterparty) |
| ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| [Internal transfer](/payouts/payout-service/internal-fund-transfers/internal-transfer-webhooks) | **internal**                                                                                                                         | **internalTransfer**                                                                                                         | `balanceAccountId`                                                                                                                           |
| [Third-party payout](/payouts/payout-service/pay-out-to-bank-accounts/payout-webhooks)          | **bank**                                                                                                                             | **bankTransfer**                                                                                                             | `bankAccount`                                                                                                                                |
