Custom Notification Buttons

Buttons that you add to your Airship project settings are available to other users in your project, ensuring that your buttons are uniform across notifications and Airship reports.

You can add buttons to App notifications to direct users to take specific actions. App notifications support one or two buttons, e.g., a single Watch Now button, or a Yes/No pair, and you associate each button with an ActionA configurable behavior that occurs when a user interacts with your message, e.g., opening a web page. . You can also add or remove a tag when the user taps a button.

Airship records button clicks to help you track how your audience engages with your messages. Airship records them as Custom EventsEvents that indicate that a user performed a predefined action, such as adding an item to a shopping cart, viewing a screen, or clicking an Unsubscribe button. Custom events can trigger automation, journeys, scenes, and surveys. You can code them into your app or website, or send them to Airship from an external source using the custom event API. Custom events contain properties that you can use to personalize messages. with the name button--<BUTTON_ID>, where BUTTON_ID is either the button’s label or ID (when using the API). These events are included in Message Reports, Event Tracking, and Real-Time Data StreamingA service that delivers engagement events in real time via the Data Streaming API or an Airship partner integration. .

Airship provides 30+ predefined buttons, which have preset labels and actions. Some buttons support changing their associated actions.

You can also create custom buttons, which must be configured in your project before you can add them to a message. Custom buttons can be associated with Airship actions, or they can be associated with custom actions.


Interactive notification buttons are tied to an action within your app, so a developer must first update your app, registering new categories in the Airship SDK.

After your developer registers the new categories, you can add buttons to your project. You will need the category name for each button.

Enable Notification Buttons

  1. Go to Settings » Project Configuration and click Manage for Dashboard Settings.
  2. Enable Notification Buttons.

Create a New Notification Button

  1. Go to Settings » Channels » Mobile Apps and click Manage for Mobile App Notification Buttons.
  2. Click New Notification Buttons.
  3. Enter a Name and Description for the button, so you can identify it.
  4. Enter the Category Name that is passed to the mobile device to identify which notification buttons to display with a message.
  5. (Optional) Clear the Enabled box if you do not yet want these buttons to appear in the list of buttons when composing messages.
  6. Specify the label and actions for each button. You must configure at least one.
    • Button Label: Identifies button label for display purposes in the dashboard. Should match the label defined in the app. Does NOT change button labels in app.
    • ID: Associates actions with the correct button label when passed by message.
    • Foreground or Background: Controls which actions are available in the dashboard. Must match button ID defined in the app.
    • Destructive: Indicates if button action causes the removal of data, features, etc. Appears red on iOS. Must match capability defined in the app. Check the box to enable.
  7. Click Save.

Include a Button in a Message

In the Content step of a composer

  1. Enable Buttons.
    1. Click Select buttons, then search for and select the buttons you want to add.
    2. (Optional and if available) Change the action associated with each button.
    3. (Optional) Set and/or remove tags when the user taps a button. Tags can help you track whether your users engage with, or dismiss, your notifications.
      1. Click Set a tag.
      2. Select Add or Remove, then search for tags that exist in the system, or create a new tag.
      3. (Optional) Click Set another tag and repeat the previous step.

      Setting one or more tags when a user interacts with a message can help you track user interactions for follow-on retargeting campaigns. For example, if you set a tag responded-campaign1, you can target users bearing the responded-campaign1 tag with another message at a later date, knowing that they are active users. Alternatively, you can re-engage users with this tag using an automated message if they are inactive for a period of time.