Ctrl+K

List block webhooks

get/api/v2/{coin}/webhooks

Returns block webhooks. The types of webhooks are 'block' and 'wallet_confirmation' notifications.

Path Parameters

  • coinstringRequired
    A cryptocurrency or token ticker symbol.
    Example: "btc"

200 Response

webhooks array[object]
type string
Event type to listen to.
Example: null
userId string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
label string
Example: Test Webhook
created string <date-time>
Example: 2018-05-05T19:46:22.019Z
coin string
A cryptocurrency or token ticker symbol.
Example: btc
url string <uri>required
Example: https://your.server.com/webhook
version integer
2 for coins running on API v2.
Example: 2
numConfirmations integer
Example: 6
state string
If 'active', indicates the webhook can trigger and send to the URL. If 'suspended', indicates the webhook can't trigger.
Allowed values: active suspended
Example: active
lastAttempt string <date-time>
Example: 2018-05-05T19:46:22.019Z
failingSince string <date-time>
Example: 2018-05-05T19:46:22.019Z
successiveFailedAttempts integer
Example: 0
walletId string
allowBlockedHosts boolean
allToken boolean
txRequestStates array[string]
If present, only transaction request state changes from the list will trigger notifications. If not present, all transaction request state changes will trigger notifications.
Allowed values: initialized pendingApproval pendingUserCommitment pendingUserRShare pendingUserGShare readyToSend pendingUserSignature pendingDelivery signed delivered canceled rejected failed
txRequestTransactionStates array[string]
If present, only transaction request transaction state changes from the list will trigger notifications. If not present, all transaction request transaction state changes will trigger notifications.
Allowed values: initialized pendingSignature eddsaPendingCommitment eddsaPendingRShare eddsaPendingGShare readyToCombineShares signed held delivered invalidSignature rejected ecdsaMPCv2Round1 ecdsaMPCv2Round2 ecdsaMPCv2Round3
identityStatus array[string]
If present, only identity status changes from the list will trigger notifications. If not present, all identity status changes will trigger notifications.
Allowed values: approved declined input error ssn error gov id error ssn verified gov id verified evaluating submission awaiting document upload records uploaded in review incomplete verifications awaiting signature signature submitted initiating additional information submitted
userKycState array[string]
If present, only user kyc state changes from the list will trigger notifications. If not present, all kyc state changes will trigger notifications.
Allowed values: approved pending rejected
enterpriseKycState array[string]
If present, only enterprise kyc state changes from the list will trigger notifications. If not present, all kyc state changes will trigger notifications.
Allowed values: approved pending rejected