Button actions in the WYSIWYG editor

When using the WYSIWYG editor for Rich PagesA landing page or Message Center message in your app that can include HTML, video, etc. and In-App AutomationMessages that are cached on users’ devices and displayed when your users meet certain conditions within your app, such as viewing a particular screen or opening the app a certain number of times. , you can assign an action that occurs when a user taps the buttons and images in the message. You can also use HandlebarsHandlebars is Airship’s templating language for personalization. Handlebars expressions use double curly braces wrapped around a content template, ranging from a simple variable, e.g., {{first_name}}, to complex evaluations of personalization data. to personalize the actions. Minimum SDKs required to support all actions: iOS 8.5.0, Android 9.0.0.

Configuring button actions

Select a button or image in your message, then configure Action in the sidebar:

1. Select and configure an action.

2. (Optional) Enter an event name to differentiate the clicks for the button.

   By default, the total clicks for all buttons and images in the message are reported using Custom EventEvents 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, sequences, 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. ua_button_tap. You can enter your own event name instead. This name is appended to the default. For instance, if you enter Cat socks55, the event name in reporting will be ua_button_tap-Cat socks55.

   Event names also support HandlebarsHandlebars is Airship’s templating language for personalization. Handlebars expressions use double curly braces wrapped around a content template, ranging from a simple variable, e.g., {{first_name}}, to complex evaluations of personalization data. .

3. (Optional for landing pages only) Check the Landing page behavior box if you want the landing page to close after the selected action occurs. When the user reopens your app, the landing page will no longer be open. Minimum SDKs required: iOS 14.2.0, Android 14.1.0.

4. (Optional) Add or remove tags when a user taps the notification:

   1. Click Configure options.
   2. Select Add or Remove, then search for tags that exist in the system or create a new tag.

   Click Configure another option to add more tags.

Actions

Supported actions:

Adaptive Link

Adaptive Link opens a mobile wallet pass. Select an Adaptive LinkA vendor-agnostic, shortened mobile wallet pass link that supports templates for both Google Wallet and Apple Wallet. When a user taps the link, Airship determines the user’s platform and generates the right pass for that platform. from the list.

• Adaptive links must be configured before they will appear in the actions list. See: Create adaptive links using the dashboard.
• Only adaptive links created in the dashboard will appear in the actions list.

App Rating

App Rating prompts the user to rate the app in the app store. Optionally enter a custom message title and body.

 Important

iOS requires that you provide your app’s Apple ID, which is used as the iTunes App Store Identifier. (Android and Amazon generate app store links automatically based on information already in your app, so no configuration is required.)

You can do this by adding the ID in your Airship project settings, or by editing your plist dictionary.

In your plist dictionary, add the following, substituting 1111111111 with the app’s actual ID:

<key>itunesID</key
<string>1111111111</string>

A quick way to find the Apple ID is to copy the numbers at the end of the app’s App Store URL. If the URL is https://apps.apple.com/app/id1195168544, the Apple ID is 1195168544.

Another way is to locate your app in iTunes Connect  and copy the Apple ID.

Deep Link

Deep Link opens a screen in your app or website. Select a deep link from the list.

• Deep links must be configured before they will appear in the actions list. See: Manage Deep Links.
• If you selected a deep link template, fill in each template segment.

Deep link templates

Our Deep Link functionality supports URL templates, which expose a friendly interface to your users in our UI, while constructing the correct URL behind the scenes on the fly. You can specify substitution parameters by enclosing them in brackets. For example, if you want to define a Deep Link for a product page screen in your app (or on your mobile website), you can make the product ID number a substitution parameter. Here are example template URLs:

https://yourcompany.com/products/{Product Id}

yourapp://products/{Product Id}

When you enter this URL in the Airship interface, the form parses it and previews the form your users see in the composer. It automatically identifies “Product Id” as the parameter name, and provides a field to substitute in the actual identifier. So if you had previously entered a product ID of 1872983490 for the above Product ID, the generated URL would be:

http://yourcompany.com/products/1872983490

yourapp://products/1872983490

The interface treats all values for each field as a string.

Dismiss Message

Dismiss Message closes the message.

Preference Center

Preference Center opens an app preference center. Select a preference center from the list.

Push Opt-in

Push Opt-in opens the system prompt for push notification opt-in. Device behavior differs depending on opt-in status:

• If a user has not previously opted out, they will see the system prompt after clicking the button.
• If a user previously opted out, the app settings will open after clicking the button, and they can opt in from there.

Share

Share prompts the user to share your message with apps, social media accounts, and other services. Enter the text you want to accompany the share, including any promotional information, shortened links, hashtags, etc.

Web Page

Web Page opens a web page or any valid-device level URL such as App Store or app protocol links. The web page opens in the device’s default browser. Enter a URL.