Organization Webhooks

List webhook notification for an organization

Changed on

List all webhook notifications for the specified organization.

get/api/v2/organization/{organizationId}/webhook/{webhookId}/notification

Request

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

Path parameters

organizationIdstring required
Example:59cd72485007a239fb00282ed480da1f
webhookIdstring required

Query parameters

type'txRequest' | 'txRequestTransaction' | 'transfer' | 'transaction' | 'transactionRemoved' | 'transactionExpire' | 'pendingapproval' | 'block' | 'admin' | 'address_confirmation' | 'lowFee' | 'circuitBreaker' | 'lowFeeAddressBalance' | 'wallet_confirmation' | 'bankAccount' | 'userKycState' | 'enterpriseKycState' | 'identityStatus' | 'idvStatus' | 'accessToken' | 'accountCreated' | 'contractSigned' | 'fundsDeposited' | 'kycResult' | 'policyBalanceChange' | 'reversal' | 'mintOrder' | 'transaction_finality_on_l1' | 'stuckTx' | 'tradeOrder' | 'unspentExpiry' | 'twoStepTransfer' | 'twoStepDeposit' | 'twoStepWithdrawal' | 'endInvestorOnboardingInvite' | 'endInvestorOnboardingAccepted' | 'pendingDecryption' | 'whitelistApproved' | 'whitelistRejected' | 'allocationRequest' | 'allocationAccepted' | 'allocationSettlementFailed'
Example:transfer

The webhook type

prevIdstring

The ID of the item to start at

limitstring number

The maximum number of items to return

Response

OK

nextBatchPrevIdstring

This is the ID from the last item in the current batch. Providing this value as the prevId in the next request will return the next batch of notifications.

Example response

{
  "webhookNotifications": [
    {
      "id": "59cd72485007a239fb00282ed480da1f",
      "wallet": "cold",
      "coin": "btc",
      "transfer": "receive",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "nextAttempt": "2021-01-01T00:00:00.000Z",
      "version": 2
    }
  ]
}

Changes

  • d083f3244790Revision changes
    • warning

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

    • info

      added the new enum value allocationSettlementFailed to the query request parameter type

  • 021ae042735eRevision changes
    • warning

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

    • info

      added the new enum value allocationAccepted to the query request parameter type