Optional Features

You can enable optional features during the Content and Delivery steps when creating or editing a Message, Automation, A/B Test, or a Push Template. Each feature's purpose and settings are detailed here.

See the Message Reference for API equivalents.

 Note

  • Available features are dependent on the message types and platforms you selected.
  • If your message audience includes both app and non-app platforms, non-OS-specific app-only features appear under App Options.
  • Web browsers do not support the Buttons, Summary, or Media features.

Background Processing

The background processing option wakes the app and give it some running time to perform work, such as downloading content for future display. Data included in the push notification is available for background processing, e.g., to send URLs and then download that content. iOS only.

Toggle to enable.

Badge

Update the recipient device's app badge. A badge is the numeric display on an app icon that typically indicates the number of unread messages. iOS only.

By default messages automatically increment the badge number, but you can specify an exact number, e.g., +3, +12, -3.

Toggle to enable, then select either Increment by 1 or Specify. Specify requires a value in the text field.

Buttons

Add buttons to bring even more interactivity to your messaging. Buttons prompt a user to take specific action from your notification. You can also trigger an Airship Message Action A behavior that occurs when a user interacts with your message. when your audience clicks or taps a button. See: Interactive Notifications. Buttons are single or paired, e.g., a single Watch Now button and a Yes/No pair.

Toggle to enable, click Select buttons, and search for and select the buttons you want to add.

Campaign Categories

Campaign categories are labels that group messages of a similar type or messaging strategy for aggregate reporting. Campaigns help you track the efficacy of both your individual messages and a messaging campaign as a whole.

Toggle to enable, enter a campaign category name, then click Add. Click the X next to any category to remove it. Category names have a 64-character maximum. Enter up to ten.

 Tip

Campaign categories are listed in the Message Detail section of Message Reports.

Collapse Key

A collapse key suppresses a group of messages using the same same key value. Only the most recent message (using the same key) will be viewable.
Android & Amazon only.

Toggle to enable, then type the key in the text field.

Critical

Send the notification as a critical alert. Critical alerts are push notifications that play sounds and ignore the device's Do Not Disturb mode and mute switch settings. This delivery feature is available for iOS 12 and later only and requires a special entitlement from Apple.

Toggle to enable, then use the slider to select the alert volume level. Volume can be specified at 10% increments.

 Note

  • Critical alerts require a special entitlement issued by Apple, If you do not have this entitlement, you will not see this option in the dashboard.

  • These notifications should contain information that require a user to take immediate action.

  • Critical Alerts must be allowed by a user on their device.

Custom Keys

Custom keys are additional key-value pairs in your push notification payload for use by custom code in your app. You can use custom keys to pass additional campaign identifiers for analytics, pass user information to the device, control the look and feel of the app, provide image links, etc.

By default, a custom key is sent to push notifications on all platforms, but you can choose platform-specific keys as well if your message is going out to more than one platform, e.g., one imageURL for iOS and another imageURL for Android.

Toggle to enable, select a platform from the dropdown menu, then enter the key and value. Click Add Another for additional keys.

Delay While Idle

The delay while idle option delays delivery of your message until Firebase Cloud Messaging (FCM) detects that the device is active. This can increase the likelihood of the user engaging with the notification. Android only.

Toggle to enable.

Delivery Priority

The delivery priority option sends your notification using Firebase Cloud Messaging (FCM) high priority. When not enabled, messages default to normal priority. Android only. Toggle to enable.
 Note

From Google's About FCM Messages: Delivery options: Setting the priority of a message:

High priority. FCM attempts to deliver high priority messages immediately, allowing the FCM service to wake a sleeping device when necessary and to run some limited processing (including very limited network access). High priority messages generally should result in user interaction with your app. If FCM detects a pattern in which they don't, your messages may be de-prioritized.

Expiration

The delivery expiration option discards your message if it hasn't been delivered to a device within a specific period of time.

Toggle to enable, then select the radio button for either Duration or Date & Time.

  • Duration: Enter the number of minutes, hours, or days past your defined send time to expire the delivery.

  • Date & Time: Enter the date and time when delivery attempts should cease.

Push Notifications
If a device is online, the notification will be delivered immediately. If a device is offline, the push service for each platform, e.g., APNs for iOS and FCM for Android, preserves the notification and attempts to deliver it as soon as it comes online, up until the expiration date.

For Web Notifications, if no expiration is set and a device is offline, the delivery service, e.g., Google or Mozilla, preserves the notification and attempts to deliver it as soon as it comes online, for a maximum of 28 days.

There is no way to remove a delivered push notification.

In-App Messages
Since In-App Messages are delivered via push notifications, they will not be delivered past the expiration date if the user has been offline. In addition, Airship will not display an in-app message past the expiration date.

Expiration (SMS)

The delivery expiration option discards your message if it hasn't been delivered to a device within a specific period of time.
72 hours is the default. SMS Only.

Enter the number of hours, between 1 and 72.

Group

A delivery group uses an identifier to group related notifications from your app into a single stack. Notifications bearing the same group identifier are stacked together. iOS 12 and later only. Toggle to enable, then type an identifier in the text field.
 Note

Remember to use the same identifier for subsequent messages you wish to group.

Icon

Add an icon for web push notifications, overriding the default icon specified in your Web Notifications configuration. Web only. Safari is not supported.

Toggle to enable, then enter the URL for your icon. The URL must be HTTPS and should be accessible by your audience; the icon must be a static image.

If your account has CDN enabled, you can Upload media rather than entering a URL. Select the radio button for Upload, click Upload Media, and select a media file. The maximum file size is 2 MB.

Contact Airship Support if you are interested in enabling CDN media hosting.

Supported Media for Icons

  • Images: JPEG, JPG, PNG

Media

Add media to your notification. Toggle to enable.

Android and/or Amazon only
Enter the URL for the media to be displayed with the push notification. Only static images are supported. See the API reference for "style". Ensure the URL will be accessible by your mobile audience. HTTPS is required.
iOS Only
Enter the URL for the media to be displayed with the push notification. Image, animated gif, audio, and video are supported. See the API reference for allowed file types and requirements. Ensure the URL will be accessible by your mobile audience. HTTPS is required. Options:
  • Hide iOS 10 thumbnail: By default, a thumbnail of the media is displayed in the message alert.

  • Media Specific Content: By default, iOS 10+ devices will receive the Same push notification as pre-iOS 10 devices. If you would like to send a different message to iOS 10+ devices, select Write Alternative, and enter alternative message text in the iOS 10 Push Notification field.

  • Alternate Title and Summary fields will appear here only if the Title and Summary options preceding Media have been enabled and filled out.

iOS with Android and/or Amazon
When you enable both the iOS platform and one or more of Android and Amazon, and you do not enter a static image in the initial URL field, a Static Image field is aded to the media settings. Enter a URL as described in Android and/or Amazon only above.

Upload Media

If your account has CDN enabled, you can Upload media rather than entering a URL. Select the radio button for Upload, click Upload Media, and select a media file. The maximum file size is 2 MB.

Contact Airship Support if you are interested in enabling CDN media hosting.

Supported Media for App Channels

  • Images: JPEG, GIF, PNG
  • Audio: AIFF, WAV, MP3, M4A
  • Video: AVI, MPEG, MPEG2, MP4

Mutable Content

The mutable content option allows a notification’s content to be changed or downloaded before delivery. This feature is automatically enabled if media is defined in the message's Optional Features » Media settings. iOS 10 and later only.

Toggle to enable.

Notification Category

Send your message with a specific notification category instead of the default. A notification category is a grouping mechanism for messages in Android versions 8.0 and later, synonymous with Android notification channels. Users can set behaviors for each notification category within your Android app, determining the types of messages they are most interested in.

Toggle to enable, then select a category from the dropdown menu.

 Note

You must add your app's notification categories to your Airship project before you can select them for your messages. Navigate to Settings » Configuration » Android Notification Categories.

Require Interaction

 Important

Support for Require Interaction varies by browser and OS.

Enable the Require interaction setting to require your audience to interact with your web notification to dismiss it from the browser window. Web only.

Users may interact with a web notification in these ways:

  • Click the notification, which opens the message-defined URL, or the default Action URL.
  • Dismiss the notification.
  • Click the Settings icon or button on the notification.

Toggle to enable.

Sound

Play a custom sound when your audience receives a message. The file must be bundled with your app by your app developer. iOS only.

Toggle to enable, then enter the name of the sound file, e.g., "default" or "beep.caf".

Start and End Dates

Start and end dates define the times during which your automation can deliver messages to your audience.

  • If you set a start date, the message status is automatically set to Pending until the specified date and time occur.
  • After the start date and time pass, the automation status changes to Active.
  • After the end date and time pass, the automation status changes to Completed, and the automation quits sending messages.
  1. Enable the Start Date and/or End Date options.
  2. Click the date field and either use the date picker, or enter a date in YYYY-MM-DD format.
  3. Use the dropdown menus to select the time and time zone.

Summary

Add a summary line, supplemental text displayed with the primary notification message. Toggle to enable, then type your summary in the text field.

  • iOS 10 and later: The summary appears below the push notification title. See: iOS 10 documentation.

  • Android and Amazon: The summary appears below the main notification text in most cases. This is the only visible text other than the title when Android Picture is visible in expanded mode, as the main notification text is suppressed. See: Android documentation.

Title

Enter a title to create a heading that appears above the notification text in:

  • iOS Notification Center
  • Apple Watch Looks
  • Android and Amazon Notification Area/Drawer

For web browsers, the title set here will override the default title.

Toggle to enable, then type the title in the text field.