Ctrl+K

Simulate a webhook

post/api/v2/organization/{organizationId}/webhook/{webhookId}/simulate

Simulate a webhook for testing purposes. To call this endpoint, you must have the user_manage scope on a short-lived access token created either in the web app or programmatically using the Login endpoint.

Path Parameters

  • organizationIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters
  • webhookIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

Request Body

One of
transferId string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$

200 Response

webhookNotifications array[object] required
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
type string
Event type to listen to.
Allowed values: txRequest txRequestTransaction transfer transaction transactionRemoved transactionExpire pendingapproval block admin address_confirmation lowFee circuitBreaker wallet_confirmation bankAccount userKycState enterpriseKycState identityStatus accessToken accountCreated contractSigned fundsDeposited kycResult policyBalanceChange transaction_finality_on_l1
wallet string
Example: cold
url string
hash string
coin string
A cryptocurrency or token ticker symbol.
Example: btc
coinChain string
transfer string
Example: receive
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: unconfirmed new pending processed failed
simulation boolean
retries number
webhook string
updatedAt string <date-time>
Example: 2021-01-01T00:00:00.000Z
nextAttempt string <date-time>
Example: 2021-01-01T00:00:00.000Z
version number
Example: 2
allowBlockedHosts boolean
heightToConfirm number
payload string
response object

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

401 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

403 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id