Organization Webhooks

Create organization webhook

Changed on

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.

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

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/v2/organization/{organizationId}/webhook
  • Auth
    none declared

Path parameters

organizationIdstring required
Example:59cd72485007a239fb00282ed480da1f

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Response

OK

idstring required
createdstring date-time required
urlstring uri required
versionnumber required

2 for coins running on API v2.

scope'wallet' | 'enterprise' | 'organization' | 'safe' required
state'active' | 'suspended' required

If 'active', indicates the webhook can trigger and send to the URL. If 'suspended', indicates the webhook can't trigger.

successiveFailedAttemptsnumber required
listenToFailureStatesboolean required

Whether or not to listen to failed transactions on chain.

coinstring

A cryptocurrency or token ticker symbol.

labelstring

Label of the new webhook.

walletIdstring
enterpriseIdstring
organizationIdstring
userIdstring
type'transfer' | 'txRequest' | 'pendingapproval' | 'txRequestTransaction' | 'bankAccount' | 'identityStatus' | 'idvStatus' | 'userKycState' | 'enterpriseKycState' | 'accessToken' | 'reversal' | 'tradeOrder' | 'whitelistApproved' | 'whitelistRejected'
numConfirmationsnumber
lastAttemptstring date-time
failingSincestring date-time
allTokenboolean
txRequestStatesstring[]
txRequestTransactionStatesstring[]

Example response

{
  "id": "59cd72485007a239fb00282ed480da1f",
  "created": "2021-01-01T00:00:00.000Z",
  "url": "https://your.server.com/webhook",
  "version": 2,
  "state": "active",
  "coin": "btc",
  "organizationId": "59cd72485007a239fb00282ed480da1f",
  "numConfirmations": 6,
  "lastAttempt": "2021-01-01T00:00:00.000Z",
  "failingSince": "2021-01-01T00:00:00.000Z"
}

Changes

  • fd11eb1bc5f6Revision changes
    • warning

      added the new redpallasRerandRound1 enum value to the / response property for the response status

    • warning

      added the new redpallasRerandRound2 enum value to the / response property for the response status

    • info

      added the new redpallasRerandRound1 enum value to the request property //

    • info

      added the new redpallasRerandRound2 enum value to the request property //

  • 021ae042735eRevision changes
    • warning

      added the new redpallasMPCv2Round1 enum value to the / response property for the response status

    • warning

      added the new redpallasMPCv2Round2 enum value to the / response property for the response status

    • warning

      added the new redpallasMPCv2Round3 enum value to the / response property for the response status

    • info

      added the new redpallasMPCv2Round1 enum value to the request property //

    • info

      added the new redpallasMPCv2Round2 enum value to the request property //

    • info

      added the new redpallasMPCv2Round3 enum value to the request property //