Register Webhook

Registers a webhook to the wallet.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
number
required

Wallet index

Body Params
string
enum
required

Webhook type. A webhook is sent when the corresponding event occurs.

DEPOSIT: When a deposit transaction becomes FINALIZED

UNFINALIZED_DEPOSIT: When a deposit transaction becomes UNFINALIZED

WITHDRAWAL: When a withdrawal request succeeds and its transaction completes (FINALIZED or FAILED)

GATHERING: When a gathering request succeeds and its transaction completes (FINALIZED or FAILED)

NFT_DEPOSIT: When an NFT deposit transaction becomes FINALIZED

UNFINALIZED_NFT_DEPOSIT: When an NFT deposit transaction becomes UNFINALIZED

NFT_WITHDRAWAL: When an NFT withdrawal request succeeds and its transaction completes (FINALIZED or FAILED)

NFT_DEPLOYMENT: When an NFT contract deployment request succeeds and its transaction completes (FINALIZED or FAILED)

NFT_ITEM_CREATION: When an NFT item creation request succeeds and its transaction completes (FINALIZED or FAILED)

NFT_CONTRACT_METHOD_EXECUTION: When an NFT contract execution request succeeds and its transaction completes (FINALIZED or FAILED)

NFT_BURN: When an NFT burn request succeeds and its transaction completes (FINALIZED or FAILED)

FAILED_WITHDRAWAL: When a withdrawal request fails at the request stage (before it is broadcast to the blockchain)

SENT_WITHDRAWAL: When a withdrawal request succeeds and its transaction has been created

AWAITING_SIGNING_WITHDRAWAL: When the withdrawal transaction has been built successfully and is awaiting signing

SIGNING_TRANSACTION: When a transaction signing request succeeds and the request completes (SUCCESS or FAILED)

SIGNING_DATA: When a data signing request succeeds and the request completes (SUCCESS or FAILED)

CONTRACT_EXECUTION: When a contract execution request succeeds and its transaction completes (FINALIZED or FAILED)

COMPLETED_BRIDGE: When all stages of a bridge request finish and its final status becomes COMPLETED. Sent to the source wallet.

SOURCE_FETCH_KEY_FAILED_BRIDGE: When fetching the key of the sending (source) wallet of a bridge request fails. Sent to the source wallet.

DESTINATION_FETCH_KEY_FAILED_BRIDGE: When fetching the key of the receiving (destination) wallet of a bridge request fails. Sent to the source wallet.

string
required
length ≤ 10

Webhook name. Names must be unique within a wallet.

string
required

URL that receives the webhook.

string
length ≤ 100

Key used to verify the integrity of the webhook.

Headers
string
required
Defaults to Bearer

API token

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json