Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated per Dashboard 5.0.0

...

  1. In Dashboard, select your application from the Apps menu.
  2. From the left-side navigation, select Cloud > Push Notifications.
  3. Click Send Push Notification to open the Send Push Notification form
  4. Select either the Standard or Advanced tab.
  5. Select Recipients and (optionally) the notification Channel Name:
    1. To send a notification to all users regardless of their channel subscriptions, select All Users and leave the Channel Name field blank. 
    2. To send a notification to all users subscribed to a particular channel, select All Users and enter the channel name in the Channel Name field.
    3. To send a notification to specific users who are subscribed to a particular channel, select Specific Users, then:
      1. Click the add (+) button in the To Users field.
      2. Select the desired recipients from the list of users. To locate a particular user, enter their username in the search field.
      3. In the Channel Name field enter the name of the target channel subscription. Note: You must specify a channel when sending a notification to specific users.
    4. To send a notification to all users located within a geographic selection, select Geographic Selection, then:
      1. Click the add (+) button in the Place field and select an existing place. This defines the center points of the geographic selection. The selected Place must have a defined latitude and longitude.
      2. In the Radius field, enter the distance (in Miles or Meters) from the selected Place to define the size of the geographic selection.

  6. To specify when to deliver the notification, in the Send When field, select one of the following options:
    1. To send the notification immediately, select Send Now.
    2. To schedule a one-time notification, select One-Time and then select the delivery date and time (All times are in UTC.)
    3. To schedule a recurring notification, select Recurring, select the start date and time, the end date, and the recurrence interval: Daily, Weekly, or Monthly. (All times are in UTC.)
  7. To define the notification payload using the Standard view:
    1. In the Alert field, enter the notification message to display on the device.
    2. In the Badge field, enter a badge value. See Notification Badges for details.

    3. In the Sound field, select None, Default, or Custom. See Notification Sounds for details.

    4. For iOS devices:

      1. In the Content-Available field, check the box to indicate that new content is available. This is used to support Newsstand apps and background content downloads.

      2. In the Category field, enter the name of the category to use for interactive notifications. See iOS Interactive Notifications.

    5. For Android devices:
      1. in the Vibrate field, select No or Yes to have the device vibrate or not upon receipt of the notification.
      2. In the Title field (Android, only), select the title to display in the Alert message. See Notification Titles for details.
      3. In the Icon field (Android, only), specify the name of the image file to display as the notification icon. See Notification Icons for details. 
  8. To define the notification payload using the Advanced view:
    1. In the Custom JSON field, enter a valid JSON string (see Custom JSON Payloads for details).
      Image RemovedImage Added
  9. Click Send Now

...

Below is a more advanced custom JSON payload:

Code Block
{
    "alert": "Sample alert",
    "badge": "+2",
    "category": "sampleCategory", 
    "icon": "little_star",
    "sound": "door_bell",
    "title": "Example",
    "vibrate": true,
    "custom_field_1": "Arrow Push Rocks!",
    "custom_field_2": "Hi Push"
}

When the device receives this payload, it will do the following:

  • Display the "Sample alert" message.
  • Increment the current badge value by two.
  • Play the "door_bell" audio file.
  • On Android devices: 
    • The notification title will be set to "Example"
    • The device will vibrate
    • The "little_star" icon will be displayed in the notification area.
  • On iOS 8 devices and later:
    • The user notification actions associated with the "sampleCategory" user notification category.

About JSON Payloads Delivered to Devices Devices

The notification payload that Mobile Backend Services delivers to either FCM or GCM or APNS is slightly modified from the original JSON payload you provide to Dashboard. Also, the payloads are slightly different for Android and iOS devices.

For Android, all Android-specific fields are contained in an android dictionary, while all other iOS-only and custom fields are top-level keys of the payload. For example, the payload shown in Custom JSON payloads will be delivered to an Android application as follows:

Code Block
{
    "android": {
        "title": "Example",
        "alert": "Sample alert",
        "icon": "little_star",
        "badge": "+2",
        "sound": "door_bell",
        "vibrate": true,
    },
    "category": "sampleCategory",
    "custom_field_1": "Arrow Push Services Rocks!",
    "custom_field_2": "Hi Push"
}

For iOS devices, all iOS-specific fields are contained in an aps dictionary, while all Android-specific and custom fields are top-level keys of the payload. For example, For example, the payload shown in Custom JSON payloads will be delivered to an iOS application as follows:

Code Block
{ "aps": { "alert": "Sample alert", "badge": "+2", "category": "sampleCategory", "sound": "door_bell", }, "title": "Example", "icon": "little_star", "vibrate": true, "custom_field_1": "Arrow Push Rocks!", "custom_field_2": "Hi Push" }

 

Notification Features

Interactive Notifications (iOS 8 and later)

...