API References
Start typing to search…

Add wallet webhook

post
https://app.bitgo-test.com/api/v2//wallet//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. Learn more about webhooks on the Developer Portal.

Note: Before you process webhook notifications, BitGo strongly recommends that you verify response details by fetching the transfer or block data from BitGo. For example, if you create a transfer webhook and you receive a transfer ID, pass that ID to the Get Transfer endpoint to verify the transfer details.

Path Params
string
required
length ≥ 1

A cryptocurrency symbol or token ticker symbol

string
required
length ≥ 1
Body Params
string
enum
required

Event type to listen to.

uri
required
length ≥ 1

URL to fire the webhook to.

string

Label of the new webhook.

number

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.

boolean
Defaults to false

Triggers on coin transfers and token transfers for ETH and Stellar. Must be set to true to receive webhooks for Trade accounts.

boolean

Whether or not to listen to failed transactions on chain.

txRequestStates
array of strings
txRequestStates
txRequestTransactionStates
array of strings
txRequestTransactionStates
customHttpHeaders
object

Custom HTTP header key/values to be included with every notification for the webhook.

Responses

Updated 27 days ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 27 days ago