v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB

Notifications

List notification channels

List all notification channels.

get/api/v1/notification/channels

Query parameters

includeDeletedboolean

Include deleted notification channels in response.

Usage: ?includeDeleted=true

includeDisabledboolean

Include disabled notification channels in response.

Usage: ?includeDisabled=false

pageinteger

Page index.

Default is 1.

pageSizeinteger

The maximum number of items per page.

Default is 100.

order'ASC' | 'DESC'

The order direction.

orderBy'id' | 'type' | 'createdAt' | 'updatedAt'

Order by options for notification channels.

The order by field.

Response

The request has succeeded.

totalCountinteger required

The total number of items.

pageinteger required

The page index.

pageSizeinteger required

The maximum number of items per page.

Example response

{
  "totalCount": 500,
  "page": 1,
  "pageSize": 100,
  "items": [
    {
      "createdAt": "2024-01-01T01:01:01.001Z",
      "updatedAt": "2024-01-01T01:01:01.001Z",
      "deletedAt": "2024-01-01T01:01:01.001Z",
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "name": "customer-webhook",
      "disabled": true,
      "annotations": {
        "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
      },
      "metadata": {
        "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
      },
      "url": "https://example.com/webhook",
      "signingSecret": "whsec_S6g2HLnTwd9AhHwUIMFggVS9OfoPafN8"
    }
  ]
}