Webhooks

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

  • Deposit received

  • Withdrawal broadcast

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 deposit transaction.

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