Sign in
OpenMeter Notifications

Get notification channel

Changed on

Get a notification channel by id.

get/openmeter/notification/channels/{notificationChannelId}

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/notification/channels/{notificationChannelId}
  • Auth: none declared

Path parameters

notificationChannelIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

NotificationChannel response.

idstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

namestring required

Display name of the resource.

Between 1 and 256 characters.

labelsLabels

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

created_atstring date-time required

RFC3339 formatted date-time string in UTC.

updated_atstring date-time required

RFC3339 formatted date-time string in UTC.

deleted_atstring date-time

RFC3339 formatted date-time string in UTC.

type'webhook' required

The type of a notification channel.

Currently the only supported channel type is webhook; the domain model anticipates additional channel types (e.g. email, Slack) in the future, so this is modeled as an enum rather than a boolean/constant even though it has a single member today.

disabledboolean

Whether the channel is disabled. Disabled channels do not receive notification events.

urlstring required

The URL that webhook notification events are delivered to.

custom_headersobject

Custom HTTP headers to include on every webhook delivery request, keyed by header name.

signing_secretstring

Secret used to sign outgoing webhook payloads so recipients can verify their authenticity. If omitted on create, a secret is generated automatically by the delivery provider. This is a sensitive credential returned in responses (unlike most secrets) specifically so clients can retrieve a server-generated value and verify webhook signatures; handle it with the same care as any other credential.

Example response

{
  "id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "labels": {
    "env": "test"
  },
  "created_at": "2023-01-01T01:01:01.001Z",
  "updated_at": "2023-01-01T01:01:01.001Z",
  "deleted_at": "2023-01-01T01:01:01.001Z"
}

Changes

  • v3d62eba97457cRevision changes
    • ○

      added to the response property allOf list for the response status

    • ○

      removed from the response property allOf list for the response status

  • v3ff2a080bd662Revision changes
    • ○

      endpoint added