Skip to content

Commit 67fb955

Browse files
feat: update bitgo-api-docs
This commit updates the BitGo API.
1 parent 6de8ff2 commit 67fb955

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

api.yaml

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -391,19 +391,16 @@ paths:
391391
post:
392392
summary: Add wallet webhook
393393
description: |-
394-
Add a webhook to a wallet that sends an HTTP callback from BitGo to a specified URL when specific conditions occur.
395-
A wallet can have up to 10 webhooks of each wallet-webhook type.
394+
Add a webhook to a wallet that sends an HTTP callback from BitGo to a specified
395+
URL when specific conditions occur. A wallet can have up to 10 webhooks of each
396+
wallet-webhook 'type'. Learn more about webhooks on the
397+
[Developer Portal](https://developers.bitgo.com/guides/wallets/webhooks).
396398

397-
Wallet-webhook types:
398-
1. **Address confirmation** - An address initializes on chain (ETH and XRP only).
399-
2. **Pending approval** - A wallet-level policy-triggering event occurs (such as a withdrawal, user change,
400-
policy change, pending approval state updates, and so forth).
401-
402-
3. **Transaction request** - A transaction request state changes.
403-
4. **Transfer** - Any transfer occurs.
404-
405-
**Note:** Unconfirmed webhook notifications don't trigger for [RBF](https://bitcoinops.org/en/topics/replace-by-fee/) transactions,
406-
or if a transaction confirms on chain immediately after it's sent. BitGo doesn't send 'unconfirmed' notifications in these cases.
399+
**Note:** Before you process webhook notifications, BitGo strongly recommends that
400+
you verify response details by fetching the transfer or block data from BitGo. For
401+
example, if you create a transfer webhook and you receive a transfer ID, pass that
402+
ID to the [Get Transfer](/api/v2.wallet.gettransfer) endpoint to verify the transfer
403+
details.
407404
operationId: v2.wallet.addwebhook
408405
tags:
409406
- Webhook
@@ -32991,7 +32988,7 @@ components:
3299132988
properties:
3299232989
item:
3299332990
type: string
32994-
description: Either a valid address or a wallet or enterprise id. Must be unique in this whitelist.
32991+
description: Either a valid address or a wallet, enterprise, or organization id. Must be unique in this whitelist.
3299532992
metaData:
3299632993
type: object
3299732994
additionalProperties: {}
@@ -33017,7 +33014,7 @@ components:
3301733014
properties:
3301833015
item:
3301933016
type: string
33020-
description: Either a valid address or a wallet or enterprise id. Must be unique in this whitelist.
33017+
description: Either a valid address or a wallet, enterprise, or organization id. Must be unique in this whitelist.
3302133018
metaData:
3302233019
type: object
3302333020
additionalProperties: {}
@@ -33081,6 +33078,7 @@ components:
3308133078
- address
3308233079
- enterpriseId
3308333080
- walletId
33081+
- organizationId
3308433082
required:
3308533083
- item
3308633084
verifyItems:
@@ -33099,6 +33097,7 @@ components:
3309933097
- address
3310033098
- enterpriseId
3310133099
- walletId
33100+
- organizationId
3310233101
AggregatorSourceType:
3310333102
title: AggregatorSourceType
3310433103
type: string
@@ -44447,6 +44446,7 @@ components:
4444744446
title: OrganizationRole
4444844447
type: string
4444944448
enum:
44449+
- serviceUser
4445044450
- admin
4445144451
- member
4445244452
- customer
@@ -45519,6 +45519,7 @@ components:
4551945519
role:
4552045520
type: string
4552145521
enum:
45522+
- serviceUser
4552245523
- admin
4552345524
- member
4552445525
- customer

0 commit comments

Comments
 (0)