latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Organization Webhooks

List organization webhooks

List all webhooks for a specified organization.

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

Path parameters

organizationIdstring required
Example:59cd72485007a239fb00282ed480da1f

Query parameters

type'transfer' | 'txRequest' | 'pendingapproval' | 'txRequestTransaction' | 'bankAccount' | 'identityStatus' | 'idvStatus' | 'userKycState' | 'enterpriseKycState' | 'accessToken' | 'reversal' | 'tradeOrder' | 'whitelistApproved' | 'whitelistRejected'
prevIdstring
limitstring number

Maximum number of webhooks to return per page.

Response

OK

nextBatchPrevIdstring

Example response

{
  "webhooks": [
    {
      "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"
    }
  ]
}