Simulate block webhook

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

Simulates and tests a block webhook so you can view its response.

Path Parameters

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

Request Body

blockId string
Example: 0000000000000296ed56abee6cb78e40b00c47a03d92e71dd92c4862ca636b95
javascript
1 2 3 4 5 6 7 8 9 10 11 var baseCoin = bitgo.coin('tbtc'); var webhooks = baseCoin.webhooks(); webhooks .simulate({ webhookId: '590cd…35835', blockId: '00000…507d6', }) .then(function (result) { console.dir(result); });

200 Response

webhookNotifications array[object]
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