Built-In Interactive Notification Types

Predefined App Buttons

Airship provides a set of standard Interactive Notification types.

The Airship library, along with the custom user notification types, will always register the following set:

Type	Type ID	Examples	Description	Button 1 label	B1 ID	B1 Foreground	Button 2 label	B2 ID	B2 Foreground
Yes or No (Open the app)	ua_yes_no_foreground	Would you like to fill out a survey? [Yes] [No]	Yes option takes user into the app. No dismisses the notification, but can record a tag.	Yes	yes	TRUE	No	no	FALSE
Yes or No (Dismiss notification)	ua_yes_no_background	Would you receive black friday offers? [Yes] [No]	Yes and No options dismiss the notification when clicked, without taking the user into the app.	Yes	yes	FALSE	No	no	FALSE
Accept or Decline (Open the app)	ua_accept_decline_foreground	Would you like to fill out a survey? [Accept] [Decline]	Accept option takes the user into the app. No dismisses the notification, but can record a tag.	Accept	accept	TRUE	Decline	decline	FALSE
Accept or Decline (Dismiss notification)	ua_accept_decline_background	Would you receive black friday offers? [Accept] [Decline]	Yes and No options dismiss the notification when clicked, without taking the user into the app.	Accept	accept	FALSE	Decline	decline	FALSE
Shop Now	ua_shop_now	20% off Men’s shoes [Shop now]	Shop Now takes user into the app; should be a different location from the notification action. Can also set a tag.	Shop Now	shop_now	TRUE	n/a	n/a	n/a
Buy Now	ua_buy_now	20% off Men’s shoes [Buy Now]	Buy Now takes user into the app; should be a different location from the notification action. Can also set a tag.	Buy Now	buy_now	TRUE	n/a	n/a	n/a
Follow	ua_follow	New York City bans the plastic bag. [Follow]	Follow sets a tag allowing a user to opt in to receiving more notifications about a story, offer, event, program, etc.	Follow	follow	FALSE	n/a	n/a	n/a
Opt-in	ua_opt_in	Would you receive Black Friday offers? [Opt-in]	Opt-in sets a tag allowing a user to opt in to receiving more notifications about a story, offer, event, program, etc.	Opt-in	opt_in	FALSE	n/a	n/a	n/a
Unfollow	ua_unfollow	Black Friday Furby Boom 80% off Last Chance! [Unfollow]	Unfollow sets a tag allowing a user to stop receiving notifications about a story, offer, event, program, etc.	Unfollow	unfollow	FALSE	n/a	n/a	n/a
Opt-out	ua_opt_out	Black Friday Furby Boom 80% off Last Chance! [Opt-out]	Opt-out sets a tag allowing a user to stop receiving notifications about a story, offer, event, program, etc.	Opt-out	opt_out	FALSE	n/a	n/a	n/a
Opt-in / Remind Me Later	ua_opt_in_remind	Black Friday Furby Boom 80% off Last Chance! [Opt-in] [Remind me later]	Encouraging Opted-Out Users to Opting In to a program, feature or option. Remind can set tag for retargeting.	Opt-in	opt_in	No	Remind Me Later	remind	No
Remind Me Later	ua_remind_me_later	Black Friday Furby Boom 80% off Last Chance! [Remind Me Later]	Remind Me Later sets a tag that can be used for retargeting a message, e.g. manually or with automation	Remind Me Later	remind	FALSE	n/a	n/a	n/a
Tell Me More	ua_more_info	Black Friday Furby Boom 80% off Last Chance! [Tell me more]	Deep link to more details about a specific offer or program	Tell Me More	more_info	Yes
Download	ua_download	Weekly wallpaper view of the Grand Canyon [Download]	Download deep links users directly to media e.g. wallpaper images, apps, music downloads, file downloads, etc.	Download	download	TRUE	n/a	n/a	n/a
Share	ua_share	Obama wins the election! [Share]	Pass sharing text through to native OS apps like Facebook and Twitter using the UA Share Action.	Share	share	TRUE	n/a	n/a	n/a
Download / Share	ua_download_share	Weekly wallpaper view of the Grand Canyon [Share] [Download]	Download deep links users directly to media e.g. wallpaper images, apps, music downloads, file downloads, etc. Share the same media socially.	Download	download	TRUE	Share	share	TRUE
Remind Me Later / Share	ua_remind_share	Black Friday Furby Boom 80% off Last Chance! [Share] [Remind Me Later]	Remind Me Later sets a tag that can be used for retargeting a message, e.g. manually or with automation. See UA Share Action.	Remind Me Later	remind	FALSE	Share	share	TRUE
Opt-in / Share	ua_opt_in_share	Would you receive Black Friday offers? [Share] [Opt-in]	Opt-in sets a tag allowing a user to opt in to receiving more notifications about a story, offer, event, program, etc. See UA Share Action.	Opt-in	opt_in	FALSE	Share	share	TRUE
Opt-out / Share	ua_opt_out_share	Black Friday Furby Boom 80% off Last Chance! [Share] [Opt-out]	Opt-out sets a tag allowing a user to stop receiving notifications about a story, offer, event, program, etc. See UA Share Action.	Opt-out	opt_out	FALSE	Share	share	TRUE
Follow / Share	ua_follow_share	New York City bans the plastic bag. [Share] [Follow]	Follow sets a tag allowing a user to opt in to receiving more notifications about a story, offer, event, program, etc. See UA Share Action.	Follow	follow	FALSE	Share	share	TRUE
Unfollow / Share	ua_unfollow_share	Black Friday Furby Boom 80% off Last Chance! [Share] [Unfollow]	Unfollow sets a tag allowing a user to stop receiving notifications about a story, offer, event, program, etc. See UA Share Action.	Unfollow	unfollow	FALSE	Share	share	TRUE
Shop Now / Share	ua_shop_now_share	20% off Men’s shoes [Share] [Shop now]	Shop Now takes user into the app; should be a different location from the notification action. Can also set a tag. See UA Share Action.	Shop Now	shop_now	TRUE	Share	share	TRUE
Buy Now / Share	ua_buy_now_share	20% off Men’s shoes [Share] [Buy Now]	Buy Now takes user into the app; should be a different location from the notification action. Can also set a tag. See UA Share Action.	Buy Now	buy_now	TRUE	Share	share	TRUE
More Like This / Less Like This	ua_more_like_less_like	Take 30% off of all Mead notebooks and White Out. [More Like This] [Less Like This]	Let users opt in to additional messages of this type. Set tags in the background.	More Like This	more_like	FALSE	Less Like This	less_like	FALSE
Like / Dislike	ua_like_dislike	Justin Bieber just got a pet poodle in prison and named it Sparky. [Like] [Dislike]	Capture user sentiment by recording the # of likes/dislikes of a message. Optionally set tags for retargeting.	Like	like	FALSE	Dislike	dislike	FALSE
Like	ua_like	Justin Bieber just got a pet poodle in prison and named it Sparky. [Like]	Capture user sentiment by allowing users to like a message. Optionally set a tag for retargeting.	Like	like	FALSE	n/a	n/a	n/a
Like / Share	ua_like_share	Weird Al playing at the Moda Center this weekend, last chance to buy tickets. [Like] [Share]	Capture user sentiment by allowing users to like a message, or share. Optionally set tags for retargeting.	Like	like	FALSE	Share	share	TRUE
Add to Calendar	ua_add_calendar_remind	Add David Bowie Look-Alike Contest to your calendar? [Add to calendar]	Add a calendar event (.ics file) to the calendar on the phone.	Add to Calendar	add_calendar	Yes	Remind Me Later	remind	No
Add	ua_add	Add Wesley Willis Tribute Concert ticket to your Wallet now. [Add]	Add an item: most frequently a wallet pass or card to your digital Wallet	Add	add	Yes
Save / No	ua_save	Tiger Flees Zoo, Steals Ice Cream Truck! [Save]	Save something for future reference	Save	save	No
Follow / Save	ua_follow_save	Tiger Flees Zoo, Steals Ice Cream Truck! [Follow] [Save]	Give customer choice of following a story, which implies opting in to ongoing notifications, vs. merely saving it for future reference.	Follow	follow	No	Save	save	No
Rate Now	ua_rate	Show us some love in the app store. [Rate now]	Drive users to rate the app in the app store by deep linking from this button	Rate Now	rate	Yes
Rate Now / Remind Me Later	ua_rate_remind	Show us some love in the app store. [Rate now] [Remind me later]	Prompt users to rate app or alternative set tag for retargeting and reminding user to rate at future date.	Rate Now	rate	Yes	Remind Me Later	remind	No
Search	ua_search	Find a deal on Weird Al plastic Furby shoes? [Search]	Deep link to a search functionality within the app	Search	search	Yes
Book Now	ua_book	Rest up for Black Friday! Save your hotel room early. [Book now]	Deep link to booking flow within an app	Book Now	book	Yes

Emoji

You may also assign button labels that render on the device as emoji.

Note

For iOS and devices running Android M or higher, the types will render as emoji as shown below. For older Android versions we use icons instead of emoji.

Type	Type ID	Examples	Description	Button 1 label	B1 ID	B1 Foreground	Button 2 label	B2 ID	B2 Foreground
😄 / 😒	`ua_icons_happy_sad`	Justin Bieber just got a pet poodle in prison and named it Sparky. 😄 😒	Capture user sentiment by recording the number of happy/sad emotions for a message. Optionally set tags for retargeting.	😄	happy	FALSE	😒	sad	FALSE
👍 / 👎	`ua_icons_up_down`	Justin Bieber just got a pet poodle and named it Sparky 👍 👎	Capture user sentiment by recording the number of thumbs up or down for a message. Optionally set tags for retargeting.	👍	up	FALSE	👎	down	FALSE

Feedback

Was this page helpful?