HomeNotification

Version 2019-04 (latest)

Home item to display a notification.

Required access

read_home access scope

Show definition
"""
Home item to display a notification.
"""
type HomeNotification {
  """
  Message being displayed after dismissing the notification.
  """
  dismissMessage: FormattedString
  """
  Indicates if the notification can be dismissed or not.
  """
  dismissible: Boolean!
  """
  Unique identifier for use in analytics.
  """
  id: ID!
  """
  A more detailed description of the notification.
  """
  message: FormattedString
  """
  Indicates severity of the notification for styling and grouping.
  """
  severity: HomeNotificationSeverity!
  """
  Text for the header of the notification.
  """
  title: FormattedString!
}

Fields

dismissMessage (FormattedString)

Message being displayed after dismissing the notification.

dismissible (Boolean!)

Indicates if the notification can be dismissed or not.

id (ID!)

Unique identifier for use in analytics.

message (FormattedString)

A more detailed description of the notification.

severity (HomeNotificationSeverity!)

Indicates severity of the notification for styling and grouping.

title (FormattedString!)

Text for the header of the notification.

Sign up for a Partner account to get started.

Sign up