OPopenmeter
Notifications

List notification channels

List all notification channels.

get/api/v1/notification/channels

Request

  • Base URL
    https://openmeter.cloud (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or API key in cookie __session

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.

pageinteger required

The page index.

pageSizeinteger required

The maximum number of items per page.

totalCountinteger required

The total number of items.

Example response

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

Changes

No recorded changes to this operation across all 2 revisions of this API.