ResourceAlert

Required access

read_false access scope

Presents information or problems to merchants, with 1 or more actions that they can take. They can optionally have a specific icon and be dismissed by merchants.

Show definition
# Presents information or problems to merchants, with 1 or more actions that they can take.
# They can optionally have a specific icon and be dismissed by merchants.
type ResourceAlert {
  # Buttons in the alert that link to related information.
  # For example, _View risk assessment_.
  actions: [ResourceAlertAction!]!

  # Details about the alert.
  content: HTML!

  # Unique identifier that appears when an alert is manually closed by the merchant.
  # Most alerts cannot be manually closed.
  dismissibleHandle: String

  # Icon that displays with the alert.
  icon: ResourceAlertIcon

  # Indication of how important the alert is.
  severity: ResourceAlertSeverity!

  # The name of the alert.
  title: String!
}

Fields

actions   ([ResourceAlertAction!]!)

Buttons in the alert that link to related information. For example, View risk assessment.

Required access

read_ access scope

content   (HTML!)

Details about the alert.

Required access

read_ access scope

dismissibleHandle   (String)

Unique identifier that appears when an alert is manually closed by the merchant. Most alerts cannot be manually closed.

Required access

read_ access scope

icon   (ResourceAlertIcon)

Icon that displays with the alert.

Required access

read_ access scope

severity   (ResourceAlertSeverity!)

Indication of how important the alert is.

Required access

read_ access scope

title   (String!)

The name of the alert.

Required access

read_ access scope

Sign up for a Partner account to get started.

Sign up