# List Webhooks

**GET** `/webhooks`

Base URL: `https://api.uat.triple-a.io/api/fiat-payout/v1`

## Webhook data

For `document_update` events, the data posted to the webhook URL will be
the same format as the response data returned by the
`GET /documents/{documentId}` call.

For `sender_update` events, the data posted to the webhook URL will be
the same format as the response data returned by the
`GET /individuals/{individual_id}` or `GET /companies/{company_id}` call.

For `transfer_update` events, the data posted to the webhook URL will be
the same format as the response data returned by the
`GET /transfers/{transferId}` call.

For `payment_update` events, the data posted to the webhook URL will contain
the payment status update details.

For `entity_anonymisation_event` events, the data posted to the webhook
URL will contain the entity's data-retention anonymisation status,
sent both when it's upcoming and once it's completed.

## Authorization

- oauth2 (http, bearer)

## Responses

### 200

OK

- `id` (string<uuid>)
  Webhook Identifier
- `external_id` (string, required)
  A unique id specified by API caller to avoid duplication API request
- `event_type` ("document_update" | "sender_update" | "transfer_update" | "payment_update" | "entity_anonymisation_event", required)
  Specify which event this webhook URL will handle.
- `notification_url` (string<uri>, required)
  The URL to which event notification data will be `POST`ed.
- `public_key` (string)
  The URL to which event notification data will be `POST`ed.
- `headers` (object)
  Headers to be included in the notification request.
  - `key` (string)
    Header name
  - `value` (string)
    Header value

Example:

```json
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "external_id": "string",
    "event_type": "document_update",
    "notification_url": "string",
    "public_key": "string",
    "headers": {
      "key": "content-type",
      "value": "application/json"
    }
  }
]
```