List webhook subscriptions (scope webhooks:admin)

GET/api/v1/webhooks

Authorization

AuthorizationBearer token · headerrequired

Scoped API token (bnx_…). Required scopes are noted per operation.

Query parameters

$topinteger

Page size ($top, max 200).

min 1 · max 200

$skipinteger

Offset ($skip).

min 0

Responses

200

Paginated list

itemsobject[]required

Show properties

Array of object

idstringrequired

eventTypestringrequired

Allowed:matter.createdrelation.createdhour.createdtask.createdinvoice.sent

urlstringrequired

activebooleanrequired

createdAtstringrequired

totalintegerrequired

skipintegerrequired

topintegerrequired

401

Unauthenticated

errorstringrequired

codestringrequired

rulestring

403

Forbidden (missing scope or permission)

errorstringrequired

codestringrequired

rulestring

429

Rate limited

errorstringrequired

codestringrequired

rulestring

Request

curl -X GET '/api/v1/webhooks' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("/api/v1/webhooks", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/webhooks",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "items": [
    {
      "id": "string",
      "eventType": "matter.created",
      "url": "string",
      "active": true,
      "createdAt": "string"
    }
  ],
  "total": 0,
  "skip": 0,
  "top": 0
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}