Amazon Pinpoint · Schema

DefaultPushNotificationMessage

Specifies the default settings and content for a push notification that's sent directly to an endpoint.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

Name Type Description
Action object
Body object
Data object
SilentPush object
Substitutions object
Title object
Url object
View JSON Schema on GitHub

JSON Schema

amazon-pinpoint-default-push-notification-message-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-default-push-notification-message-schema.json",
  "title": "DefaultPushNotificationMessage",
  "description": "Specifies the default settings and content for a push notification that's sent directly to an endpoint.",
  "type": "object",
  "properties": {
    "Action": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Action"
        },
        {
          "description": "<p>The default action to occur if a recipient taps the push notification. Valid values are:</p> <ul><li><p>OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.</p></li> <li><p>DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.</p></li> <li><p>URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.</p></li></ul>"
        }
      ]
    },
    "Body": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The default body of the notification message."
        }
      ]
    },
    "Data": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOf__string"
        },
        {
          "description": "The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification."
        }
      ]
    },
    "SilentPush": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "description": "Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center."
        }
      ]
    },
    "Substitutions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfListOf__string"
        },
        {
          "description": "The default message variables to use in the notification message. You can override the default variables with individual address variables."
        }
      ]
    },
    "Title": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The default title to display above the notification message on a recipient's device."
        }
      ]
    },
    "Url": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL."
        }
      ]
    }
  }
}