Sign in
Notifications

Get notification details

Get notification details.

get/v1/notifications/inbox/{notificationId}

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

Changed in 2 of the 75 revisions of this API.42

  • 3c0154b2053a4See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 87c135153b842See the full diff
    • ●

      added the new cloud-gateways enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new gateway-manager enum value to the response property for the response status

      response-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog