For AI agents: markdown of this page — /docs-content-en/infra/event-subscriptions/list.md documentation index — /llms.txt

List subscriptions

GET /v1/infra/servers/:id/event-subscriptions

Returns the server's subscriptions and up to 50 recent deliveries. The recentDeliveries array is a log of the latest events with the status of each delivery and the error text if a delivery failed. Use it to check whether events are reaching the application.

Parameters

Parameter In Type Required Description
Parameterid Inpath Typestring (UUID) Requiredyes DescriptionServer ID. List: GET /v1/infra/servers

Examples

curl — personal key

Terminal
curl -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.com/v1/infra/servers/SERVER_ID/event-subscriptions

curl — OAuth application

Terminal
curl -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.com/v1/infra/servers/SERVER_ID/event-subscriptions

JavaScript — personal key

javascript
const res = await fetch(
  `https://vibecode.bitrix24.com/v1/infra/servers/${serverId}/event-subscriptions`,
  { headers: { 'X-Api-Key': 'YOUR_API_KEY' } }
)
const { success, data, recentDeliveries } = await res.json()
console.log(`Subscriptions: ${data.length}, deliveries in log: ${recentDeliveries.length}`)

JavaScript — OAuth application

javascript
const res = await fetch(
  `https://vibecode.bitrix24.com/v1/infra/servers/${serverId}/event-subscriptions`,
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)
const { success, data, recentDeliveries } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata Typearray DescriptionArray of subscriptions, newest first. Fields of each subscription — see Create subscription
FieldrecentDeliveries Typearray DescriptionUp to 50 recent deliveries, newest first. Older deliveries are not included in the response
FieldrecentDeliveries[].id Typestring (UUID) DescriptionDelivery ID
FieldrecentDeliveries[].event Typestring DescriptionEvent code
FieldrecentDeliveries[].status Typestring DescriptionDelivery status: PENDING, DELIVERING, DELIVERED, FAILED
FieldrecentDeliveries[].attempts Typenumber DescriptionNumber of delivery attempts
FieldrecentDeliveries[].lastError Typestring | null DescriptionText of the last delivery error
FieldrecentDeliveries[].createdAt Typestring DescriptionWhen the event arrived (ISO 8601)
FieldrecentDeliveries[].deliveredAt Typestring | null DescriptionWhen it was delivered to the application (ISO 8601), null if not yet delivered

Response example

JSON
{
  "success": true,
  "data": [
    {
      "id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "appId": "9a1c2b3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
      "serverId": "e765edfc-ba0a-43de-b8ea-838dd872c522",
      "portalId": "8b1f0e2a-3c4d-5e6f-7a8b-9c0d1e2f3a4b",
      "event": "ONTASKADD",
      "appPath": "/api/webhooks/b24",
      "authType": "1",
      "b24Handler": "https://vibecode.bitrix24.com/v1/portal-events/9a1c2b3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
      "status": "ACTIVE",
      "createdById": "7f3a1c2b-9d8e-4a6f-b1c2-3d4e5f6a7b8c",
      "createdAt": "2026-06-07T10:00:00.000Z",
      "updatedAt": "2026-06-07T10:00:00.000Z"
    }
  ],
  "recentDeliveries": [
    {
      "id": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
      "event": "ONTASKADD",
      "status": "DELIVERED",
      "attempts": 0,
      "lastError": null,
      "createdAt": "2026-06-07T10:05:00.000Z",
      "deliveredAt": "2026-06-07T10:05:01.000Z"
    }
  ]
}

Error response example

404 — server not found:

JSON
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Server not found"
  }
}

Errors

HTTP Code Description
HTTP403 CodeSERVER_ROLE_FORBIDDEN DescriptionYou are on this server's development team with the Developer role, and this operation is open to the Administrator role. error.hint carries your role, the required threshold and the list of calls that are open to you. Role breakdown — List servers
HTTP404 CodeNOT_FOUND DescriptionServer not found or belongs to another API key while you are not on its development team

Full list of common API errors — Errors.

Known specifics

  • A failed delivery moves the subscription to DEGRADED. Failed deliveries (the application's response is not 2xx or the server is unavailable) are retried with increasing delay. After attempts are exhausted, the delivery moves to FAILED, the subscription is marked DEGRADED, and the owner receives a notification. The recentDeliveries[].lastError field shows the reason for the last failure.

See also