The Urban Airship Unity Plugin allows a developer to integrate push notification services with Unity apps targeting both Android and iOS. This plugin is designed to be cross-platform, and applications making use of it can leverage the same code on both platforms.



  • Unity 5
  • iOS: Xcode 10+
  • Android: Android SDK installed and updated (requires Android MinSdkVersion = 16)


Download the latest plugin and import the unitypackage into the unity project: Open Assets -> Import Package -> Custom Package.

Configure Urban Airship Settings: Open Window -> Urban Airship -> Settings and set the Urban Airship settings.

After generating a project for iOS, enable Push Notifications in the project editor's Capabilities pane:

After adding the Push Notifications capability, download the Android Firebase configuration file google-services.json from the application's Firebase console into the Assets directory.

If your Unity application does not have an associated application in the Firebase console - see FCM setup instructions to set one up.

Notification Service Extension

In order to take advantage of iOS 10 notification attachments, such as images, animated gifs, and video, you will need to create a notification service extension by following the iOS Notification Service Extension Guide.

Send Your First Push Notification

UAirship.Shared.UserNotificationsEnabled = true;

Urban Airship Channel IDs

Getting the Channel ID:

string channelId = UAirship.Shared.ChannelId;

The Channel ID is a unique identifier that ties together an application/device pair on a mobile device. The Channel ID is used to target pushes to specific devices using the Urban Airship API. Once a Channel ID is created, it will persist in the application. It may or may not change when the application is reinstalled. For more information on platform-specific operation, see the Android and iOS documentation.

Don't worry if this value initially comes back as null on your app's first run (or after clearing the application data), as the Channel ID will be created and persisted during registration. To receive an event when the Channel ID is created, see Listening for Events.

Enabling User Notifications

UAirship.Shared.UserNotificationsEnabled = true;

The Urban Airship SDK makes a distinction between "user notifications", which can be seen by the user, and other forms of push that allow you to send data to your app silently, or in the background. Enabling or disabling user notifications is a preference often best left up to the user, so by default, user notifications are disabled.

Foreground Presentation Options

The SDK provides support for foreground presentation options that were introduced in iOS 10. The three UNNotificationPresentationOptions constants are badge, sound, and alert. These constants specify how to present a notification when the application receives a remote notification in the foreground. You can set default presentation options that will be applied to all remote-notifications.

Listening for Events


UAirship.Shared.OnChannelUpdated += (string channelId) => {
  Debug.Log ("Channel updated: " + channelId);


UAirship.Shared.OnDeepLinkReceived += (string deeplink) => {
  Debug.Log ("Received deep link: " + deeplink);


UAirship.Shared.OnPushReceived += (PushMessage message) => {
  Debug.Log ("Received push! " + message.Alert);

Available events:

Event when channel registration updates.
Event when a new deep link is available. The app should navigate to the proper page when the event is received.
Event when a push is received.

Addressing Devices

To help target specific devices or users for a notification, we have Tags, Named Users and Tag Groups.


// Add tag
UAirship.Shared.AddTag ("some-tag");

// Remove tag
UAirship.Shared.RemoveTag ("other-tag");

// Get tags
IEnumerable<string> tags = UAirship.Shared.Tags;

Tags allow you to attribute arbitrary metadata to a specific device. Common examples include favorites such as sports teams or news story categories.

Named Users

UAirship.Shared.NamedUserId = "coolNamedUserId";

Associating the channel with a Named User ID, will implicitly disassociate the channel from the previously associated Named User ID, if it existed.

Named Users allow you to associate multiple devices to a single user or profile that may be associated with more than one device, e.g., an end-user's Android phone and tablet. A device can have only one Named User, and a single Named User should not be associated with more than 50 devices. Named Users provide the ability to directly set tags on them (see Tag Groups).

By default, Named Users cannot be associated from the device. In this case if the devices attempts a Named User association, the association will fail and the plugin will log an error. In order to change this setting, see the Settings documentation.

Tag Groups

Channel Tag Group Example:

UAirship.Shared.EditChannelTagGroups ()
     .AddTag ("loyalty", "silver-member")
     .RemoveTag ("loyalty", "bronze-member")
     .Apply ();

Named User Tag Group Example:

UAirship.Shared.EditNamedUserTagGroups ()
     .AddTag ("loyalty", "silver-member")
     .RemoveTag ("loyalty", "bronze-member")
     .Apply ();

Tag groups are configurable namespaces for organizing tags for the channel and Named User. Please view the Tag Groups documentation for more details. The Create and push to a tag group guides you through creating and using Tag Groups.

By default, Tag Groups cannot be modified from the device. In this case if a device attempts to modify Tag Groups, the modification will fail and the SDK will log an error. In order to change this setting, see the Settings documentation.

Custom Identifiers

Associating an identifier:

UAirship.Shared.AssociateIdentifier ("some key", "some identifier");

In addition to Named Users, tags, and Tag Groups, you can assign up to 20 custom identifiers to users. Identifiers that define additional ways of looking at a user -- for example, iOS Vendor ID, iOS Advertising ID, Google Analytics CID, or any other identifier you deem significant -- can be added to your users.

Custom identifiers will be visible in the Connect data stream. We recommend adding any IDs that you may want to be visible in Connect, even if Connect does not yet support the relevant integration. Unlike the other identifiers (e.g., tags), you cannot use custom identifiers to target your users.

Message Center

The default message center can be displayed at any time.

UAirship.Shared.DisplayMessageCenter ();

Urban Airship Message Center is a place in your app where you can display persistent rich messages, including HTML, video, etc. The messages are hosted by Urban Airship, and are typically displayed in standard inbox-style within your app.