Ctrl+K

Remove wallet webhook

delete/api/v2/{coin}/wallet/{walletId}/webhooks

Removing a webhook will cause new events of the specified type to no longer trigger HTTP callbacks to your URLs

Path Parameters

  • coinstringRequired
    A cryptocurrency or token ticker symbol.
    Example: btc
  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Request Body

type string
Event type to listen to.
Allowed values: txRequest txRequestTransaction transfer transaction transactionRemoved transactionExpire pendingapproval address_confirmation lowFee block admin circuitBreaker transaction_finality_on_l1
Example: transfer
url string <uri>
Example: https://your.server.com/user_webhook
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
javascript
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
var walletId = '58d99…39604';
var url = 'http://your.server.com/webhook';

bitgo
  .coin('tbtc4')
  .wallets()
  .get({ id: walletId })
  .then(function (wallet) {
    return wallet.removeWebhook({
      url: url,
      type: 'transfer',
    });
  })
  .then(function (result) {
    console.dir(result);
  });

200 Response

removed integer
Number of wallet webhooks removed.
Example: 1

400 Response

One of
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