Webhooks allow you to set up a notification system that can be used to receive updates on certain requests made to the Blockradar API.
GET
request at regular intervals to get the final status of a request. For example, when you issue an address to a customer for deposits, you keep making a request for transactions linked to the address until you find one.
With webhooks, the resource server, Blockradar in this case, sends updates to your server when the status of your request changes. The change in status of a request is known as an event. You’ll typically listen to these events on a POST endpoint called your webhook URL.
The table below highlights some differences between polling and webhooks:
Polling | Webhooks | |
---|---|---|
Mode of update | Manual | Automatic |
Rate limiting | Yes | No |
Impacted by scaling | Yes | No |
200 OK
:
200 OK
in the HTTP header. Without a 200 OK
in the response header, we’ll keep sending events for the next 2 hours and 35 minutes:
http://localhost
or 127.0.0.1
.
To expose your local server to the internet for testing purposes, consider using a tool like ngrok or webhook.site. These tools allow you to see what the webhook payload looks like and simulate webhook events locally before deploying your application to a live environment.
Using these tools, you can ensure that your webhook integration is functioning correctly and handle any issues in a controlled, local environment before moving to production.
.htaccess
, kindly remember to add the trailing /
to the URL200 OK
HTTP response200 OK
before proceeding with the long-running tasks200 OK
HTTP response from your webhooks, we flag it as a failed attemptEvent | Description |
---|---|
deposit.success | Triggered when a deposit transaction is successfully received and confirmed on the blockchain. |
deposit.failed | Triggered when a deposit transaction fails to be processed or confirmed. |
deposit.swept.success | Triggered when funds from a deposit are successfully swept (transferred) to the master wallet. |
deposit.swept.failed | Triggered when the auto-sweep process fails to transfer funds to the master wallet. |
withdraw.success | Triggered when a withdrawal transaction is successfully executed and confirmed on the blockchain. |
withdraw.failed | Triggered when a withdrawal transaction fails to execute. This can occur due to insufficient funds, network congestion, or other blockchain-related issues. |
gateway-deposit.success | Triggered when a USDC deposit to the Gateway Wallet contract is successfully finalized and credited to the unified Gateway balance. |
gateway-deposit.failed | Triggered when a USDC deposit to the Gateway Wallet contract fails or is rejected. |
gateway-withdraw.success | Triggered when USDC is successfully minted and withdrawn on the destination chain through the Gateway Minter contract. |
gateway-withdraw.failed | Triggered when a withdrawal (mint) transaction via Gateway fails to execute, which may occur because of insufficient unified balance, invalid signature, or blockchain issues. |
signed.success | Triggered when a signed transaction is successfully executed, however, transaction is not broadcast on the blockchain. |
signed.failed | Triggered when a signed transaction fails to execute. This can occur due to network congestion, or other blockchain-related issues. |
swap.success | Triggered when a swap transaction is successfully executed and the assets are exchanged. |
swap.failed | Triggered when a swap transaction fails to execute. This can occur due to insufficient funds, network congestion, or swap contract errors. |
custom-smart-contract.success | Triggered when a custom smart contract transaction is successfully executed. This indicates that the contract interaction completed successfully on the blockchain. |
custom-smart-contract.failed | Triggered when a custom smart contract transaction fails to execute. This can occur due to various reasons such as insufficient funds, network congestion, or smart contract errors. |
staking.success | Triggered when a staking transaction is successfully executed and the assets are staked. |
staking.failed | Triggered when a staking transaction fails to execute. This can occur due to insufficient funds, network congestion, or staking contract errors. |
unstaking.success | Triggered when an unstaking transaction is successfully executed and the assets are unstaked. |
unstaking.failed | Triggered when an unstaking transaction fails to execute. This can occur due to insufficient staked balance, network congestion, or staking contract errors. |
unstaking.withdraw.success | Triggered when unstaked assets are successfully withdrawn to the user’s address. |
unstaking.withdraw.failed | Triggered when the withdrawal of unstaked assets fails to execute. This can occur due to insufficient balance, network congestion, or other blockchain-related issues. |
restaking.success | Triggered when a restaking transaction is successfully executed and the assets are restaked. |
restaking.failed | Triggered when a restaking transaction fails to execute. This can occur due to insufficient funds, network congestion, or staking contract errors. |
auto-settlement.success | Triggered when an auto-settlement transaction is successfully executed and the settlement is completed. |
auto-settlement.failed | Triggered when an auto-settlement transaction fails to execute. This can occur due to insufficient funds, network congestion, or settlement contract errors. |
salvage.success | Triggered when a salvage operation is successfully executed and the assets are recovered. |
salvage.failed | Triggered when a salvage operation fails to execute. This can occur due to insufficient funds, network congestion, or salvage contract errors. |
Type | Description |
---|---|
DEPOSIT | A deposit transaction where funds are received into a wallet address |
WITHDRAW | A withdrawal transaction where funds are sent from a wallet to an external address |
SIGNED | A signed transaction where transaction is only signed and not broadcast to network |
GATEWAY_DEPOSIT | A deposit transaction where funds are received into a gateway wallet address |
GATEWAY_WITHDRAW | A withdrawal transaction where funds are sent from a gateway wallet to an external address |
SALVAGE | A salvage operation to recover stuck or lost funds |
AUTO_SETTLEMENT | An automatic settlement transaction |
STAKING | A staking transaction where assets are staked |
UNSTAKING | An unstaking transaction where staked assets are unstaked |
RESTAKING | A restaking transaction where assets are restaked |
UNSTAKING_WITHDRAW | A withdrawal of unstaked assets |
CUSTOM_SMART_CONTRACT | A custom smart contract interaction |
SWAP | A swap transaction where one asset is exchanged for another |
Status | Description |
---|---|
PENDING | Transaction is being processed but not yet confirmed |
SUCCESS | Transaction has been successfully executed and confirmed |
FAILED | Transaction failed to execute or was rejected |
INCOMPLETE | Transaction is incomplete and may require additional steps |
type
and status
fields of webhook payloads to help you understand what kind of transaction occurred and its current state.