Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Organization Webhooks

Get organization webhook

Get an organization webhook by its ID.

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

Path parameters

organizationIdstring required
Example:59cd72485007a239fb00282ed480da1f
webhookIdstring required
Example:59cd72485007a239fb00282ed480da1f

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"
}