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" or "pendingApprovalId" is required.

Path Parameters

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

Request Body

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]
hash string
The on-chain transaction id
Example: b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26
updateAt string <date-time>
Example: {}
type string
Type of event to listen to (can be transfer or pendingapproval).
Allowed values: transfer transaction pendingapproval address_confirmation lowFee
Example: transfer
url string <uri>required
Example: https://your.server.com/webhook
version integer
Example: 2
state string
Allowed values: unconfirmed new pending processed failed
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