Ctrl+K

Simulate wallet webhook

post/api/v2/{coin}/wallet/{walletId}/webhooks/{webhookId}/simulate

Simulates and tests a webhook so you can view its response. A 'transferId', 'pendingApprovalId' or 'txRequestId' is required.

Path Parameters

  • coinstringRequired
    A cryptocurrency or token ticker symbol.
    Example: btc
  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • webhookIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Request Body

One of
transferId string required
The ID of a transfer on the specified wallet. This must be provided if the webhook is of type 'transfer'.
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
javascript
1
2
3
4
5
6
7
8
wallet
  .simulateWebhook({
    webhookId: '590cd…35835',
    transferId: '59b70…dbd44',
  })
  .then(function (result) {
    console.dir(result);
  });

200 Response

webhookNotifications array[object]
wallet string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
transfer string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
hash string
The on-chain transaction id
Example: b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
coin string
A cryptocurrency or token ticker symbol.
Example: btc
type string
Event type to listen to.
Allowed values: txRequest txRequestTransaction transfer transaction transactionRemoved transactionExpire pendingapproval address_confirmation lowFee block admin circuitBreaker transaction_finality_on_l1
Example: transfer
walletType string
Example: cold
transferType string
Example: receive
value integer
Example: 1055354
valueString string
Example: 1055354
baseValue integer
Example: 1055354
baseValueString string
Example: 1055354
feeString string
Example: 71854
initiator array[string]
Example: external
receiver string
Example: tb1q3tzuxef7qc0sl8jq6vh3hpeq0w7swmq9a7eh4p
version integer
Example: 2
state string
If 'failed', webhook notification failed to connect with the target URL. If 'new', webhook notification was newly generated, in response to an event. If 'pending', webhook notification is awaiting processing by the webhook worker. If 'processed', webhook notification successfully sent to target URL. If 'unconfirmed', webhook notification is awaiting confirmation on the blockchain.
Allowed values: failed new pending processed unconfirmed
Example: new

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code