Notification

object

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-gatewaysgateway-manager

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

Example

NotificationUpdatePayload

object

Status of the notification.

statusstringrequired

Status of the notification.

Allowed values:READUNREADARCHIVED

Example

NotificationStatus

string

Status of the notification.

Allowed values:READUNREADARCHIVED

NotificationRegion

string

Region associated to a notification.

Allowed values:USEUAUMEIN*

NotificationChannel

object

Channel subscription details for an event.

typestringrequired

Allowed values:EMAILIN_APP

enabledbooleanrequired
Example