The notify() GraphQL mutation is used to create a notification. The required permission depends on target.

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

Syntax

Below is the syntax for the notify() mutation field: 

notify(input: NotificationInput!): Notification!

Given Datatypes

For the given datatype, NotificationInput, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: NotificationInput

ParameterTypeRequired[a]DefaultDescription
messagestringyes The message to be used when notifying.
targetTargetsyes The target users for the notification. This is an enumerated list: OrgRoot, Root, Group, or All.
ids[string]yes The unique identifiers of the notifications.
titlestringyes The title for the notification.
dismissablebooleanyes Whether the notification is dismissable by the user.
severityNotificationSeverityyes The severity level of the notification. This is an enumerated list: Error, Warning, Info, or Success.
linkstring  A link that may be included, if preferred, in the notification.
linkDescriptionstring  A description of the link given in the notification.
notificationTypeNotificationTypesyes The type of notification. This is an enumerated list: Announcement, Banner.

[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.


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.


Examples

Notify users in group1 and group2 

mutation{notify(Target:Group, ids: ["GroupId1", "GroupId2"],...)}

Notify org roots in org1 and org2 

mutation{notify(Target:OrgRoot, ids: ["OrgId1", "OrgId2"],...)}

Notify all root users 

mutation{notify(Target:Root,...)}

Notify all users 

mutation{notify(Target:All,...)}

Notify user 1, 2 & 3 

mutation{notify(Target:All,["UserId1", "UserId2", "UserId3"],...)}