---
description: >-
  This page describes webhooks that may be sent to a destination configured by
  the custodian. You must contact your custodian and provide a URL for these
  webhooks to be sent.
---

# Webhooks

* [Webhooks](webhooks)
  * [Deposit received](#deposit-received)
  * [Withdrawal broadcast](#withdrawal-broadcast)
  * [Withdrawal Confirmed](#withdrawal-confirmed)
  * [Transaction Status Changed](#transaction-status-changed)
  * [Direct Party Approved](#direct-party-approved)

## Deposit received

This will be sent when a deposit is received from an address outside of your Custody instance.

#### Request details

A request will be made to the configured URL with a content type of `application/json` and a body containing the ID of the deposit transaction.

```
{
  "type": "deposit",
  "transaction_id": 123
}
```

## Withdrawal broadcast

This will be sent when a withdrawal from one of the wallets on your Custody instance has been broadcast.

#### Request details

A request will be made to the configured URL with a content type of application/json and a body containing the ID of the transaction.

```
{
  "type": "withdrawal",
  "transaction_id": 123
}
```

## Withdrawal Confirmed

This will be sent when a withdrawal from one of the wallets on your Custody instance has received at least one confirmation on the blockchain.

#### Request details

A request will be made to the configured URL with a content type of application/json and a body containing the ID of the transaction.

```
{
  "type": "withdrawal_confirmed",
  "transaction_id": 123
}
```

## Transaction Status Changed

This will be sent when a transaction from one of the wallets on your Custody instance has changed its status.

#### Request details

A request will be made to the configured URL with a content type of application/json and a body containing the ID of the transaction.

```
{
  "type": "transaction_status",
  "transaction_id": 123
}
```

## Direct Party Approved

This will be sent when a direct party entity submitted to Balance for review has been approved by Balance's compliance department.

#### Request details

A request will be made to the configured URL with a content type of application/json and a body containing the ID of the entity.

```
{
  "type": "direct_party_approved",
  "id": 123
}
```
