Notifications

Get notification details

Changed on

Get notification details.

get/v1/notifications/inbox/{notificationId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/notifications/inbox/{notificationId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

notificationIdstring required

ID of the notification.

Response

View a single notification.

idstring uuid required

Contains a unique identifier used for this resource.

titlestring required
descriptionstring required
status'READ' | 'UNREAD' | 'ARCHIVED' required

Status of the notification.

region'US' | 'EU' | 'AU' | 'ME' | 'IN' | '*' required

Region associated to a notification.

namespace'plan-and-usage' | 'organization' | 'dev-portal' | 'cloud-gateways' | 'gateway-manager' required
entity_idstring required

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

detailsobject required

Metadata associated with the notification to build actionable links.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 68d43091b84dRevision changes
    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status

  • f324fb7610e4Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status