1.0.1OAS 3.0

Notification Hub API for Konnect.

API Base URL
  • Server 1:https://global.api.konghq.com/v1

    Global Base URL

Security
personalAccessToken (http)

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) from the personal access token page in the Konnect dashboard.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

Additional Information
Contact Kong

Notifications

Operations related to notifications

List available notifications

List available notifications.

get
https://global.api.konghq.com/v1/notifications/inbox

Query Parameters

page[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filters a collection of notifications.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

A paginated list response for a collection of notifications

* Additional properties are NOT allowed.
dataarray[object]required

Properties of a notification.

* Additional properties are NOT allowed.
Show Child Parameters
metaAny Of
required
CursorMetaobject

Pagination metadata.

Show Child Parameters
get/notifications/inbox
 
application/json

Get notification details

Get notification details.

get
https://global.api.konghq.com/v1/notifications/inbox/{notificationId}

Path Parameters

notificationIdstringrequired

ID of the notification.

Response

application/json

View a single notification.

Notification

Properties of a notification.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

titlestringrequired
descriptionstringrequired
statusstringrequired

Status of the notification.

Allowed values:READUNREADARCHIVED

regionstringrequired

Region associated to a notification.

Allowed values:USEUAUMEIN*

namespacestringrequired

Allowed values:plan-and-usageorganizationdev-portalcloud-gatewaysregional-event-namespacegateway-manageradvanced-analytics

entity_idstringrequired

ID of the entity. Use ‘*’ to represent all entities of this type.

detailsobjectrequired

Metadata associated with the notification to build actionable links.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/notifications/inbox/{notificationId}
 
application/json

Update notification

Update notification.

patch
https://global.api.konghq.com/v1/notifications/inbox/{notificationId}

Path Parameters

notificationIdstringrequired

ID of the notification.

Body

application/json

Request body schema for updating notification status.

NotificationUpdatePayload

Status of the notification.

statusstringrequired

Status of the notification.

Allowed values:READUNREADARCHIVED

Response

application/json

View a single notification.

Notification

Properties of a notification.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

titlestringrequired
descriptionstringrequired
statusstringrequired

Status of the notification.

Allowed values:READUNREADARCHIVED

regionstringrequired

Region associated to a notification.

Allowed values:USEUAUMEIN*

namespacestringrequired

Allowed values:plan-and-usageorganizationdev-portalcloud-gatewaysregional-event-namespacegateway-manageradvanced-analytics

entity_idstringrequired

ID of the entity. Use ‘*’ to represent all entities of this type.

detailsobjectrequired

Metadata associated with the notification to build actionable links.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

patch/notifications/inbox/{notificationId}

Body

{ "status": "READ" }
 
application/json