Ctrl+K

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]
hash string
Example: 0000000000000296ed56abee6cb78e40b00c47a03d92e71dd92c4862ca636b95
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
webhook string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
updateAt string <date-time>
Example: {}
coin string
A cryptocurrency or token ticker symbol.
Example: btc
type string
Event type to listen to.
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
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