The listNotifications() GraphQL query returns a list of all of the notifications currently set in the system. It requires root access.

For more information on actions, previously known as notifiers, see the Actions documentation page.

Syntax

Below is the syntax for the listNotifications() query field: 

listNotifications: [Notification!]!

Returned Datatypes

The returned datatype Notification has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: Notification

ParameterTypeRequired[a]DefaultDescription
idstringyes The unique identifier for the notification.
titlestringyes The title or heading of the notification.
messagestringyes The message for the notification.
dismissablebooleanyes Whether the notification is dismissable.
severityNotificationSeverityyes The severity of the notification: Error, Warning, Info, or Success
typeNotificationTypesyes The type of the notification: Announcement or Banner
linkstring  Link accompanying the notification.
linkDescriptionstringyes A description for the link.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.