Notification Channel APIs

This article covers how to get started with the Notification Channel APIs.

Notes:
The API Tester in the v4 Portal enables you to securely call the methods of these APIs using your organization's Kentik data.
Notification channels are supported in the Kentik portal via the Settings » Notifications page. For more information, see Notifications.
Protobuf and OpenAPI specifications for Kentik’s v6 APIs are available in our api-schema-public repository.

Notification Channel Usage

The topics below provide important background information for the use of these APIs.

Overview

The Notification Channel APIs enable you to retrieve IDs for the channels in your organization's collection of notification channels (see Notifications). Each channel includes a channel type (e.g., email, Slack, PagerDuty, etc.) and a set of targets (recipients). Using the ID of a given channel, you can assign a set of recipients to receive notifications from Kentik alerts and synthetic tests, including those generated by the Synthetics Monitoring APIs and BGP Monitoring APIs.

Both REST endpoints and gRPC RPCs are provided.

Limitations

The use of this API is currently subject to the following limitations:

Read-only: Creation, modification, and deletion of channels is not supported.
No v3 channels: No support is (or will be) provided for notification channels created in Kentik's v3 portal.

Notification Channel RPCs

The tables below provide a quick reference to key information about each Remote Procedure Call in these APIs. Use the links in the tables to see schemas for the request and/or response body (if any).

Note: To test methods using your own Kentik data, use the portal's API Tester.

ListNotificationChannels

API: NotificationChannelService

REST Method

REST Endpoint

Description

GET

/notification_channel/v202210
/notification_channels

Returns list of all configured notification channels.

Request body:
None
Parameters:
None

Response body:
v202210ListNotificationChannelsResponse

SearchNotificationChannels

API: NotificationChannelService

REST Method

REST Endpoint

Description

POST

/notification_channel/v202210
/notification_channels/search

Returns list of all notification channels matching request criteria. Match criteria are treated as a logical AND, i.e. all provided criteria must match in order for an entry to be included in the response.

Request body:
v202210SearchNotificationChannelsRequest

Parameters:
None

Response body:
v202210SearchNotificationChannelsResponse

GetNotificationChannel

API: NotificationChannelService

REST Method

REST Endpoint

Description

GET

/notification_channel/v202210
/notification_channels/{id}

Returns information about a notification channel with specific ID.

Request body:
None

Response body:
v202210GetNotificationChannelResponse

Parameters:

Name	Description	Required	Type
id	Request channel ID.	true	string

Notification Channel Schemas

This API uses the following schemas.

protobufAny

Schema: protobufAny

Type: object

Properties:

Name

Value

typeUrl

type: string

value

type: string

format: byte

rpcStatus

Schema: rpcStatus

Type: object

Properties:

Name

Value

code

type: integer

format: int32

message

type: string

details

type: array

items: $ref: protobufAny

ChannelType

Schema: v202210ChannelType

Type: string

Attributes:

Key	Value
enum	CHANNEL_TYPE_UNSPECIFIED, CHANNEL_TYPE_XMATTERS, CHANNEL_TYPE_SLACK, CHANNEL_TYPE_SERVICENOW, CHANNEL_TYPE_SYSLOG, CHANNEL_TYPE_OPSGENIE, CHANNEL_TYPE_CUSTOM_WEBHOOK, CHANNEL_TYPE_SPLUNK, CHANNEL_TYPE_MSTEAMS, CHANNEL_TYPE_JSON, CHANNEL_TYPE_EMAIL, CHANNEL_TYPE_VICTOROPS, CHANNEL_TYPE_PAGERDUTY
default	CHANNEL_TYPE_UNSPECIFIED
description	• CHANNEL_TYPE_UNSPECIFIED: Invalid value. • CHANNEL_TYPE_XMATTERS: XMATTERS platform • CHANNEL_TYPE_SLACK: Slack channel • CHANNEL_TYPE_SERVICENOW: ServiceNow platform • CHANNEL_TYPE_SYSLOG: Syslog server • CHANNEL_TYPE_OPSGENIE: Atlassian Opsgenie • CHANNEL_TYPE_CUSTOM_WEBHOOK: Custom REST webhook • CHANNEL_TYPE_SPLUNK: Splunk platform • CHANNEL_TYPE_MSTEAMS: Microsoft Teams channel • CHANNEL_TYPE_JSON: webhook with JSON payload • CHANNEL_TYPE_EMAIL: E-mail • CHANNEL_TYPE_VICTOROPS: Splunk On-Call (formerly VictorOps) • CHANNEL_TYPE_PAGERDUTY: Pagerduty platform

GetNotificationChannelResponse

Schema: v202210GetNotificationChannelResponse

Type: object

Properties:

Name	Value
notificationChannel	$ref: v202210NotificationChannel

ListNotificationChannelsResponse

Schema: v202210ListNotificationChannelsResponse

Type: object

Properties:

Name

Value

notificationChannels

type: array

items: $ref: v202210NotificationChannel

description: List of notification channels

readOnly: true

invalidCount

type: integer

format: int32

description: Number of invalid entries that were not included in the list (should be always zero)

readOnly: true

NotificationChannel

Schema: v202210NotificationChannel

Type: object

Properties:

Name	Value
id	type: string description: Unique identifier of the channel readOnly: true
name	type: string description: User selected name of the channel readOnly: true
type	$ref: v202210ChannelType
enabled	type: boolean description: Administrative status readOnly: true
cdate	type: string format: date-time description: Creation timestamp (UTC) readOnly: true
edate	type: string format: date-time description: Last modification timestamp (UTC) readOnly: true

SearchNotificationChannelsRequest

Schema: v202210SearchNotificationChannelsRequest

Type: object

Properties:

Name

Value

namePattern

type: string

description: Regular expression pattern for matching the name attribute of channels. Empty string matches any name, otherwise the regular expression must consume all characters in the channel name.

types

type: array

items: $ref: v202210ChannelType

description: List of ChannelType enum values to match. Empty list matches any channel type.

includeDisabled

type: boolean

default: false

description: Include disabled channels in results.

SearchNotificationChannelsResponse

Schema: v202210SearchNotificationChannelsResponse

Type: object

Properties:

Name

Value

notificationChannels

type: array

items: $ref: v202210NotificationChannel

description: List of matching notification channels.

readOnly: true

invalidCount

type: integer

format: int32

description: Number of invalid entries that were not included in the list (should be always zero)

readOnly: true