Ctrl+K

Create organization webhook

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

Create a webhook that sends an HTTP callback from BitGo to a specified URL when specific conditions occur within an organization. Must be an organization manager to perform this action. 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

Request Body

One of
allToken boolean
coin string
includeRbf boolean
label string
listenToFailureStates boolean
numConfirmations number
type string required
Allowed value: transfer
url string required
Min length: >= 1 characters

200 Response

id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
created string <date-time>required
Example: 2021-01-01T00:00:00.000Z
url string <uri>required
Example: https://your.server.com/webhook
version number required
2 for coins running on API v2.
Example: 2
scope string required
Allowed values: wallet enterprise organization
state string required
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
successiveFailedAttempts number required
Example: 0
listenToFailureStates boolean required
Whether or not to listen to failed transactions on chain.
coin string
A cryptocurrency or token ticker symbol.
Example: btc
label string
Label of the new webhook.
walletId string
enterpriseId string
organizationId string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
userId string
type string
Event type to listen to.
Allowed values: transfer txRequest pendingapproval txRequestTransaction bankAccount identityStatus idvStatus userKycState enterpriseKycState accessToken reversal tradeOrder
numConfirmations number
Example: 6
lastAttempt string <date-time>
Example: 2021-01-01T00:00:00.000Z
failingSince string <date-time>
Example: 2021-01-01T00:00:00.000Z
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: pendingApproval canceled rejected initialized pendingDelivery delivered pendingUserSignature pendingUserCommitment pendingUserRShare pendingUserGShare readyToSend signed 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 ecdsaMPCv2Round1 ecdsaMPCv2Round2 ecdsaMPCv2Round3 eddsaMPCv2Round1 eddsaMPCv2Round2 eddsaMPCv2Round3 readyToCombineShares signed held delivered invalidSignature rejected

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