How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 Notification. 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.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

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.2.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Notifications API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

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), InvalidParameterChoiceItem (5 properties). Each schema is shown below with its type and property counts.

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

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
Where this information came from

This is an independent, third-party profile of Kong Notifications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.