HomeNotification

Required access

read_home access scope

Home item to display a notification.

Show definition
# Home item to display a notification.
type HomeNotification {
  # A single interactable button for the notification.
  button: HomeButton!

  # 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.
  handle: String!

  # 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

button   (HomeButton!)

A single interactable button for the notification.

Required access

read_ access scope

dismissMessage   (FormattedString)

Message being displayed after dismissing the notification.

Required access

read_ access scope

dismissible   (Boolean!)

Indicates if the notification can be dismissed or not.

Required access

read_ access scope

id   (ID!)

Unique identifier for use in analytics.

Required access

read_ access scope

message   (FormattedString)

A more detailed description of the notification.

Required access

read_ access scope

severity   (HomeNotificationSeverity!)

Indicates severity of the notification for styling and grouping.

Required access

read_ access scope

title   (FormattedString!)

Text for the header of the notification.

Required access

read_ access scope

Deprecated fields

Show/Hide

handle   (String!)

deprecated

Unique identifier for use in analytics.

Deprecation warning

Use id instead

Required access

read_ access scope

Sign up for a Partner account to get started.

Sign up