/api/v2/{coin}/wallet/{walletId}/webhooks
Add a webhook to a wallet that sends an HTTP callback from BitGo to a specified URL when specific conditions occur. A wallet can have up to 10 webhooks of each wallet-webhook type.
Wallet-webhook types:
Address confirmation - An address initializes on chain (ETH and XRP only).
Pending approval - A wallet-level policy-triggering event occurs (such as a withdrawal, user change, policy change, pending approval state updates, and so forth).
Transaction request - A transaction request state changes.
Transfer - Any transfer occurs.
Note: Unconfirmed webhook notifications don't trigger for RBF transactions, or if a transaction confirms on chain immediately after it's sent. BitGo doesn't send 'unconfirmed' notifications in these cases.
coin
stringRequiredbtc
>= 1 characters
walletId
stringRequired59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
>= 1 characters
type
string required txRequest
txRequestTransaction
transfer
transaction
transactionRemoved
transactionExpire
pendingapproval
block
admin
address_confirmation
lowFee
circuitBreaker
transaction_finality_on_l1
url
string <uri>
required >= 1 characters
https://your.server.com/webhook
label
string numConfirmations
number 6
allToken
boolean false
listenToFailureStates
boolean txRequestStates
array[string] pendingApproval
canceled
rejected
initialized
pendingDelivery
delivered
pendingUserSignature
pendingUserCommitment
pendingUserRShare
pendingUserGShare
readyToSend
signed
failed
txRequestTransactionStates
array[string] initialized
pendingSignature
eddsaPendingCommitment
eddsaPendingRShare
eddsaPendingGShare
ecdsaMPCv2Round1
ecdsaMPCv2Round2
ecdsaMPCv2Round3
readyToCombineShares
signed
held
delivered
invalidSignature
rejected
id
string required 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
created
string <date-time>
required 2021-01-01T00:00:00.000Z
coin
string required btc
url
string <uri>
required https://your.server.com/webhook
version
number required 2
scope
string required wallet
enterprise
organization
state
string required active
suspended
active
successiveFailedAttempts
number required 0
listenToFailureStates
boolean required label
string walletId
string enterpriseId
string organizationId
string 59cd72485007a239fb00282ed480da1f
^[0-9a-f]{32}$
userId
string type
string txRequest
txRequestTransaction
transfer
transaction
transactionRemoved
transactionExpire
pendingapproval
block
admin
address_confirmation
lowFee
circuitBreaker
wallet_confirmation
bankAccount
userKycState
enterpriseKycState
identityStatus
accessToken
accountCreated
contractAgreed
fundsDeposited
kycResult
policyBalanceChange
transaction_finality_on_l1
numConfirmations
number 6
lastAttempt
string <date-time>
2021-01-01T00:00:00.000Z
failingSince
string <date-time>
2021-01-01T00:00:00.000Z
allToken
boolean txRequestStates
array[string] pendingApproval
canceled
rejected
initialized
pendingDelivery
delivered
pendingUserSignature
pendingUserCommitment
pendingUserRShare
pendingUserGShare
readyToSend
signed
failed
txRequestTransactionStates
array[string] initialized
pendingSignature
eddsaPendingCommitment
eddsaPendingRShare
eddsaPendingGShare
ecdsaMPCv2Round1
ecdsaMPCv2Round2
ecdsaMPCv2Round3
readyToCombineShares
signed
held
delivered
invalidSignature
rejected
name
string context
object required error
string required requestId
string required name
string context
object required error
string required requestId
string required name
string context
object required error
string required requestId
string required name
string context
object required error
string required requestId
string required name
string context
object required error
string required requestId
string required