Ctrl+K

Add block webhook

post/api/v2/{coin}/webhooks

Adds a webhook that will result in an HTTP callback at the specified URL from BitGo when events are triggered.

Types of block webhooks:

  1. Block webhooks will fire when a new block is seen on the coin network.
  2. Wallet confirmation webhooks will fire when a wallet has been initialized.

Path Parameters

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

Request Body

type string required
Allowed values: block wallet_confirmation
Example: block
url string <uri>required
URL to fire the webhook to.
Example: https://your.server.com/webhook
label string
Label of the new webhook.
numConfirmations integer
Number of confirmations before triggering the webhook. If 0 or unspecified, requests will be sent to the callback endpoint when the transfer is first seen and when it is confirmed.
Minimum: >= 0
Example: 6

200 Response

type string
Event type to listen to.
Allowed value: block
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: {}
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: {}
failingSince string <date-time>
Example: {}
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

400 Response

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