Unity SDK setup

​

Overview

​

Setting up push notifications for your Unity app using OneSignal

Integrating push notifications into your Unity app is a powerful way to boost user engagement and retention. OneSignal’s Unity SDK supports iOS (APNS), Android (FCM), Amazon (ADM), and Huawei devices, enabling real-time messaging with minimal effort.

Whether you’re building mobile games or interactive apps, this guide helps you integrate OneSignal quickly and reliably.

​

Requirements

• Unity 2021.3 or newer
• Configured OneSignal app and platform

iOS Requirements

• macOS with Xcode 14+ (setup instructions use Xcode 16.2)
• Device with iOS 12+, iPadOS 12+, or Xcode simulator running iOS 16.2+

Android Requirements

• Android 7.0+ device or emulator with Google Play Store (Services) installed

​

Configure your OneSignal app and platform

Required setup for push notifications

To start sending push notifications with OneSignal, you must first configure your OneSignal app with all the platforms your support—Apple (APNs), Google (FCM), Huawei (HMS), and/or Amazon (ADM).

​

Setup

​

1. Add the OneSignal Unity SDK

Two installation methods are available:

Name        npmjs
URL         https://registry.npmjs.org
Scope(s)    com.onesignal

​

2. Platform setup

Add all the platforms your app supports.

​

iOS setup

Our SDK auto-configures the required Xcode settings. Choose your provisioning approach:

​

Android setup

1. Go to Edit > Project Settings > Player > Android.
2. Under Publishing Settings, enable:

• Custom Main Gradle Template
• Custom Gradle Properties Template

3. Run Assets > External Dependency Manager > Android Resolver > Force Resolve.

Additional considerations:

• Target API Level must be 33+ (v5.0.6+).
• If Minify is enabled, run Copy Android plugin to Assets from OneSignal SDK Setup to use OneSignalConfig.androidlib.
• Replace the default icons within Assets/Plugins/Android/OneSignalConfig.androidlib/src/main/res with your own (lowercase file names only, underscores allowed). See Customize Notification Icons for more.

​

Amazon setup

​

Huawei setup

​

3. Initialize the SDK

Add this code inside the Start() method of a MonoBehaviour early in your application’s lifecycle.

Replace YOUR_APP_ID with your OneSignal App ID found in your OneSignal dashboard Settings > Keys & IDs.

using OneSignalSDK;

void Start () {
  // Enable verbose logging for debugging (remove in production)
  OneSignal.Debug.LogLevel = LogLevel.Verbose;
  // Initialize with your OneSignal App ID
  OneSignal.Initialize("YOUR_APP_ID");
  // Use this method to prompt for push notifications.
  // We recommend removing this method after testing and instead use In-App Messages to prompt for notification permission.
  await OneSignal.Notifications.RequestPermissionAsync(true);
}

​

Testing the OneSignal SDK integration

This guide helps you verify that your OneSignal SDK integration is working correctly by testing push notifications, subscription registration, and in-app messaging.

​

Check mobile subscriptions

​

Set up test subscriptions

Test subscriptions are helpful for testing a push notification before sending a message.

​

Send test push via API

curl -X \
POST --url 'https://api.onesignal.com/notifications' \
 --header 'content-type: application/json; charset=utf-8' \
 --header 'authorization: Key YOUR_APP_API_KEY' \
 --data \
 '{
  "app_id": "YOUR_APP_ID",
  "target_channel": "push",
  "name": "Testing basic setup",
  "headings": {
  	"en": "👋"
  },
  "contents": {
    "en": "Hello world!"
  },
  "included_segments": [
    "Test Users"
  ],
  "ios_attachments": {
    "onesignal_logo": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
  },
  "big_picture": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
}'

​

Send an in-app message

In-app messages let you communicate with users while they are using your app.

​

User identification

Previously, we demonstrated how to create mobile Subscriptions. Now we’ll expand to identifying Users across all their subscriptions (including push, email, and SMS) using the OneSignal SDK. We’ll cover External IDs, tags, multi-channel subscriptions, privacy, and event tracking to help you unify and engage users across platforms.

​

Assign External ID

Use an External ID to identify users consistently across devices, email addresses, and phone numbers using your backend’s user identifier. This ensures your messaging stays unified across channels and 3rd party systems (especially important for Integrations).

Set the External ID with our SDK’s login method each time they are identified by your app.

​

Add data tags

Tags are key-value pairs of string data you can use to store user properties (like username, role, or preferences) and events (like purchase_date, game_level, or user interactions). Tags power advanced Message Personalization and Segmentation allowing for more advanced use cases.

Set tags with our SDK addTag and addTags methods as events occur in your app.

In this example, the user reached level 6 identifiable by the tag called current_level set to a value of 6.

We can create a segment of users that have a level of between 5 and 10, and use that to send targeted and personalized messages:

​

Add email and/or SMS subscriptions

Earlier we saw how our SDK creates mobile subscriptions to send push and in-app messages. You can also reach users through emails and SMS channels by creating the corresponding subscriptions.

• Use the addEmail method to create email subscriptions.
• Use the addSms method to create SMS subscriptions.

If the email address and/or phone number already exist in the OneSignal app, the SDK will add it to the existing user, it will not create duplicates.

You can view unified users via Audience > Users in the dashboard or with the View user API.

​

Privacy & user consent

To control when OneSignal collects user data, use the SDK’s consent gating methods:

• setConsentRequired(true): Prevents data collection until consent is given.
• setConsentGiven(true): Enables data collection once consent is granted.

See our Privacy & security docs for more on:

• Data collected by the SDK
• Handling personal data

​

Prompt for push permissions

Instead of calling requestPermission() immediately on app open, take a more strategic approach. Use an in-app message to explain the value of push notifications before requesting permission.

For best practices and implementation details, see our Prompt for push permissions guide.

​

Listen to push, user, and in-app events

Use SDK listeners to react to user actions and state changes.

The SDK provides several event listeners for you to hook into. See our SDK reference guide for more details.

​

Push notification events

• addClickListener(): Detect when a notification is tapped. Helpful for Deep Linking.
• addForegroundLifecycleListener(): Control how notifications behave in foreground.

For full customization, see Mobile Service Extensions.

​

User state changes

• addObserver() for user state: Detect when the External ID is set.
• addPermissionObserver(): Track the user’s specific interaction with the native push permission prompt.
• addObserver() for push subscription: Track when the push subscription status changes.

​

In-app message events

• addClickListener(): Handle in-app click actions. Ideal for deep linking or tracking events.
• addLifecycleListener(): Track full lifecycle of in-app messages (shown, clicked, dismissed, etc.).

​

Advanced setup & capabilities

Explore more capabilities to enhance your integration:

• 🔁 Migrating to OneSignal from another service
• 🌍 Location tracking
• 🔗 Deep Linking
• 🔌 Integrations
• 🧩 Mobile Service Extensions
• 🛎️ Action buttons
• 🌐 Multi-language messaging
• 🛡️ Identity Verification
• 📊 Custom Outcomes
• 📲 Live Activities

​

Mobile SDK setup & reference

Make sure you’ve enabled all key features by reviewing the Mobile push setup guide.

For full details on available methods and configuration options, visit the Mobile SDK reference.