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

200 Response

webhookNotifications array[object]
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
wallet string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
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
transfer string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
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.