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}$

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
A transaction hash for transactions, or a block hash for block notifications.
Example: null
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
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
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
organization string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
bankAccount string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
url string <uri>
Example: https://your.server.com/webhook
coin string
A cryptocurrency or token ticker symbol.
Example: btc
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
simulation boolean
Example: false
retries integer
The number of retries that have been attempted for this webhook notification.
Example: 0
webhook string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
updateAt string <date-time>
Example: {}
nextAttempt string <date-time>
Example: {}
version integer
Example: 2
idempotencyKey string
A unique id that can be used to de-duplicate notifications.

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