Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Notifications API

Operations related to notifications

Kong Notifications API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Notifications. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.

This API exposes 11 operations across 6 paths, and defines 34 schemas. It is described by OpenAPI 3.1.0, at version 3.14.0.

Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.

11 operations 6 paths 34 schemas 2 DELETE5 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Kong Notifications API declares 1 security scheme for authenticating requests. An API key is passed in the header as Kong-Admin-Token (adminToken). By default, every request must be authenticated.

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Notifications 11

Operations related to notifications

GET
/v1/notifications/configurations
List available user configurations
list-user-configurations 1 param → 200400401403
GET
/v1/notifications/configurations/{eventId}/subscriptions
List event subscriptions
list-event-subscriptions 1 param → 200400401403
POST
/v1/notifications/configurations/{eventId}/subscriptions
Create a new subscription for an event
create-event-subscription 1 param body → 201400401403404
GET
/v1/notifications/configurations/{eventId}/subscriptions/{subscriptionId}
Get subscription for an event
get-event-subscription 2 params → 200400401403404
PATCH
/v1/notifications/configurations/{eventId}/subscriptions/{subscriptionId}
Update subscription for an event
update-event-subscription 2 params body → 200400401403404
DELETE
/v1/notifications/configurations/{eventId}/subscriptions/{subscriptionId}
Delete subscription associated with event
delete-event-subscription 2 params → 204401403404
GET
/v1/notifications/inbox
List available notifications
list-notifications 3 params → 200400401403
GET
/v1/notifications/inbox/{notificationId}
Get notification details
get-notification-details 1 param → 200401403404
PATCH
/v1/notifications/inbox/{notificationId}
Update notification
update-notification 1 param body → 200400401403404
DELETE
/v1/notifications/inbox/{notificationId}
Delete notification
delete-notification 1 param → 204401403404
POST
/v1/notifications/inbox/bulk
Mark a list of notifications to a status
bulk-notifications body → 200400401403404

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are Notification (10 properties), EventSubscriptionResponse (9 properties), UserConfiguration (6 properties), EventSubscription (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
UserConfiguration
object
Properties of an event.
6 properties 6 required
EntityTypes
string
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
ConfigurationFilterParameters
object
4 properties
NotificationNamespace
string
Notification
object
Properties of a notification.
10 properties 10 required
UUID
string
Contains a unique identifier used for this resource.
LegacyStringFieldFilter
object
Filter using one of the following operators: eq, contains
2 properties
DefaultSubscription
object
2 properties 2 required
UnauthorizedError
ForbiddenError
CursorMetaPage
object
5 properties 3 required
BulkPayload
object
Request body schema for bulk status update.
2 properties 2 required
ListCursorMeta
CursorMeta
object
Pagination metadata.
1 property 1 required
EventSubscriptionResponse
object
Properties associated with an event subscription.
9 properties 9 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
NotificationStatus
string
Status of the notification.
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
NotificationFilterParameters
object
5 properties
InvalidParameters
array
invalid parameters
NotificationUpdatePayload
object
Status of the notification.
1 property 1 required
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
NotificationRegion
string
Region associated to a notification.
NotificationChannelType
string
NotificationChannel
object
Channel subscription details for an event.
2 properties 2 required
EventSubscription
object
Properties associated with an event subscription.
5 properties 5 required
NotFoundError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-notifications-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API