Overview
iOS push notifications are essential for driving sustained user engagement and retention in your iOS app. They empower you to deliver real-time updates, reminders, and personalized messages directly to your users, improving the overall user experience and stickiness of your app. By integrating OneSignal’s SDK with your app, you can take advantage of Apple Push Notification Service (APNS) to ensure your notifications are delivered seamlessly across iOS devices. This guide will walk you through integrating our SDK into your iOS app.Requirements
- macOS with Xcode 14+ (setup instructions use Xcode 16.2)
- Device with iOS 12+, iPadOS 12+, or Xcode simulator running iOS 16.2+
- Configured OneSignal app and platform
Configurer votre application OneSignal et votre plateforme
Configurez votre application OneSignal avec les plateformes que vous prenez en charge — Apple (APNs), Google (FCM), Huawei (HMS) et/ou Amazon (ADM).Si votre organisation possède déjà un compte OneSignal, demandez à être invité à l’Organisation. Sinon, inscrivez-vous pour un compte gratuit pour commencer.
Instructions de configuration étape par étape
Instructions de configuration étape par étape
Créer ou sélectionner votre application
Créez une nouvelle application en cliquant sur New App/Website, ou ajoutez une plateforme à une application existante dans Settings > Push & In-App. Sélectionnez la ou les plateformes que vous souhaitez configurer et cliquez sur Next: Configure Your Platform.

Configurer les identifiants de plateforme
Entrez les identifiants pour votre plateforme :
- Android : Configurer les identifiants Firebase
- iOS : Jeton p8 (Recommandé) ou Certificat p12
- Amazon : Générer une clé API
- Huawei : Autoriser OneSignal
iOS setup
Follow these steps to add push notifications to your iOS app, including support for Badges, Confirmed Delivery, and images.1. Add Push Notifications capability to app target
The Push Notifications capability allows your app to register a push token and receive notifications.- Open your app’s
.xcworkspacefile in Xcode. - Select your app target > Signing & Capabilities
- Click + Capability and add Push Notifications capability

2. Add Background Modes capability to app target
This enables your app to wake in the background when push notifications arrive.- Add Background Modes capability
- Enable Remote notifications

3. Add app target to App Group
App Groups allow data sharing between your app and the Notification Service Extension. Required for Confirmed Delivery and Badges.- If you do NOT have an App Group configured
- If you DO have an App Group
- Add App Groups capability
- In the App Groups capability click +
- Add a new container ID in format:
group.your_bundle_id.onesignal
- Keep group. and .onesignal prefix and suffix. Replace
your_bundle_idwith your app’s bundle identifier. - For example, bundle identifier
com.onesignal.MyApp, will have the container namegroup.com.onesignal.MyApp.onesignal.

4. Add Notification Service Extension
The Notification Service Extension (NSE) enables rich notifications and Confirmed Delivery analytics.- In Xcode: File > New > Target…
- Select Notification Service Extension, then Next.
- Set the product name to
OneSignalNotificationServiceExtensionand press Finish. - Press Don’t Activate on the Activate scheme prompt.



If you’re using CocoaPods, set the deployment version in your Podfile as well.

5. Add NSE target to app group
Use the same App Group ID you added in step 3.- Go to OneSignalNotificationServiceExtension > Signing & Capabilities
- Add App Groups
- Add the exact same group ID

6. Update NSE code
- Navigate to the OneSignalNotificationServiceExtension folder
- Replace the contents of the
NotificationService.swiftorNotificationService.mfile with the following:


SDK setup
This section will guide you through integrating OneSignal’s core features. By the end of this section, you will have a basic integration with our SDK enabling you to trigger in-app messages and receive push notifications.1. Add SDK
Add our SDK using Xcode Package Dependencies Manager (Swift Package Manager) or CocoaPods. There are 4 available libraries. If you do not want In-app messages and/or Location tracking, you can omit these packages.| Library | Target | Required |
|---|---|---|
| OneSignalExtension | OneSignalNotificationServiceExtension | ✅ |
| OneSignalFramework | App | ✅ |
| OneSignalInAppMessages | App | Recommended |
| OneSignalLocation | App | Optional |
- Xcode Package Dependencies
- CocoaPods
Navigate to File > Add Package Dependencies… and enter the URL to the OneSignal SDK repository:
For more details, see Apple’s Adding package dependencies doc.
https://github.com/OneSignal/OneSignal-XCFrameworkSelect the onesignal-xcframework package and click Add Package.Choose Package Products for OneSignal-XCFramework.- Important: Add the OneSignalExtension to the OneSignalNotificationServiceExtension Target.
- Add the OneSignalFramework to your App Target.
- If you plan on using in-app messages (recommended) and/or location tracking, then add those packages to your App Target as well.

2. Initialize SDK
Depending on your Xcode interface setup, initialize OneSignal following these options.- SwiftUI
- Storyboard
If using SwiftUI interface, navigate to your
<APP_NAME>App.swift file and initialize OneSignal with the provided methods.Replace YOUR_APP_ID with your OneSignal App ID found in your OneSignal dashboard Settings > Keys & IDs. If you don’t have access to the OneSignal app, ask your Team Members to invite you.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
Launch your app on a test device.
The native push permission prompt should appear automatically if you added the 
requestPermission method during initialization.
Check your OneSignal dashboard
Before accepting the prompt, check the OneSignal dashboard:
- Go to Audience > Subscriptions.
- You should see a new entry with the status “Never Subscribed”.

Refresh the OneSignal dashboard Subscription's page.
The subscription’s status should now show Subscribed.

You have successfully created a mobile subscription.
Mobile subscriptions are created when users first open your app on a device or if they uninstall and reinstall your app on the same device.
Set up test subscriptions
Test subscriptions are helpful for testing a push notification before sending a message.Add to Test Subscriptions.
In the dashboard, next to the subscription, click the Options (three dots) button and select Add to Test Subscriptions.

Name your subscription.
Name the subscription so you can easily identify your device later in the Test Subscriptions tab.
Name the segment.
Name the segment
Test Users (the name is important because it will be used later).Send test push via API
Get your App API Key and App ID.
In your OneSignal dashboard, go to Settings > Keys & IDs.
Update the provided code.
Replace
YOUR_APP_API_KEY and YOUR_APP_ID in the code below with your actual keys. This code uses the Test Users segment we created earlier.Check images and confirmed delivery.
If all setup steps were completed successfully, the test subscriptions should receive a notification with an image included:

Images will appear small in the collapsed notification view. Expand the notification to see the full image.
Check for confirmed delivery.
In your dashboard, go to Delivery > Sent Messages, then click the message to view stats.You should see the confirmed stat, meaning the device received the push.
If you’re on a Professional plan or higher, scroll to Audience Activity to see subscription-level confirmation:


You have successfully sent a notification via our API to a segment.
Send an in-app message
In-app messages let you communicate with users while they are using your app.Close or background your app on the device.
This is because users must meet the in-app audience criteria before a new session starts. In OneSignal, a new session starts when the user opens your app after it has been in the background or closed for at least 30 seconds. For more details, see our guide on how in-app messages are displayed.
Create an in-app message.
- In your OneSignal dashboard, navigate to Messages > In-App > New In-App.
- Find and select the Welcome message.
- Set your Audience as the Test Users segment we used previously.

Schedule frequency.
Under Schedule > How often do you want to show this message? select Every time trigger conditions are satisfied.

Make message live.
Click Make Message Live so it is available to your Test Users each time they open the app.
You have successfully setup the OneSignal SDK and learned important concepts like:
- Gathering Subscriptions, setting Test subscriptions, and creating Segments.
- Sending Push with images and Confirmed Delivery using Segments and our Create message API.
- Sending In-app messages.
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’slogin method each time they are identified by your app.
OneSignal generates unique read-only IDs for subscriptions (Subscription ID) and users (OneSignal ID).As users download your app on different devices, subscribe to your website, and/or provide you email addresses and phone numbers outside of your app, new subscriptions will be created.Setting the External ID via our SDK is highly recommended to identify users across all their subscriptions, regardless of how they are created.
Add data tags
Tags are key-value pairs of string data you can use to store user properties (likeusername, 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.




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
addEmailmethod to create email subscriptions. - Use the
addSmsmethod to create SMS subscriptions.

Best practices for multi-channel communication
- Obtain explicit consent before adding email or SMS subscriptions.
- Explain the benefits of each communication channel to users.
- Provide channel preferences so users can select which channels they prefer.
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.
Prompt for push permissions
Instead of callingrequestPermission() 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.
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.).
Désactiver le method swizzling (facultatif)
Par défaut, le SDK OneSignal utilise le method swizzling pour gérer automatiquement les méthodes de délégué de notification push. Si votre application doit désactiver le swizzling (par exemple, pour éviter les conflits avec d’autres SDKs ou pour maintenir un contrôle total sur les méthodes de délégué de notification), vous pouvez le désactiver viaInfo.plist.
Lorsque le swizzling est désactivé, vous devez transférer manuellement les méthodes de délégué de notification au SDK OneSignal. Toutes les autres fonctionnalités du SDK (listeners, observers, messages in-app, outcomes, etc.) continuent de fonctionner normalement.
Étape 1. Ajouter le flag dans Info.plist
Ajoutez ce qui suit auInfo.plist de votre application :
Étape 2. Définir le délégué UNUserNotificationCenter
Définissez votreAppDelegate comme délégué de UNUserNotificationCenter avant d’appeler OneSignal.initialize. Sans cela, l’affichage des notifications au premier plan et la gestion des appuis sur les notifications ne fonctionneront pas.
Étape 3. Transférer les méthodes de délégué de notification
Implémentez les méthodes suivantes dans votreAppDelegate. Toutes les méthodes sont acheminées via OneSignal.Notifications.
Enregistrement du token :
OSNotification. S’il est non-nil, le SDK souhaite que la notification soit affichée — passez vos options de présentation préférées. S’il est nil (p.ex., un aperçu IAM), ne passez aucune option de présentation.
Le listener de cycle de vie
onWillDisplayNotification et les APIs preventDefault / display continuent de fonctionner avec le transfert manuel. Le SDK invoque vos listeners depuis handleWillPresentNotificationInForegroundWithPayload.Facultatif : Définir le nombre de badges
Lorsque le swizzling est désactivé, le SDK ne peut pas intercepter les changements de badge. Utilisez cette méthode pour définir le nombre de badges et garder le cache de badges interne d’OneSignal synchronisé :Applications SwiftUI
Les applications SwiftUI n’ont pas deAppDelegate par défaut. Utilisez @UIApplicationDelegateAdaptor pour en ajouter un, puis implémentez toutes les méthodes de transfert présentées ci-dessus :
Swift
Référence API
| Méthode | Objectif |
|---|---|
didRegisterForRemoteNotifications(_:deviceToken:) | Transférer le token de dispositif APNs à OneSignal |
handleDidFailRegisterForRemoteNotification(_:) | Transférer l’échec d’enregistrement APNs |
receiveRemoteNotification(_:userInfo:completionHandler:) | Transférer les notifications en arrière-plan/silencieuses |
handleWillPresentNotificationInForegroundWithPayload(_:withCompletion:) | Transférer la notification au premier plan pour le traitement du SDK |
handleNotificationResponse(_:) | Transférer l’appui/action de notification au SDK |
setBadgeCount(_:) | Définir le nombre de badges et synchroniser avec le cache du SDK |
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.Congratulations! You’ve successfully completed the Mobile SDK setup guide.
Besoin d’aide ?Discutez avec notre équipe d’assistance ou envoyez un e-mail à
support@onesignal.comVeuillez inclure :- Les détails du problème que vous rencontrez et les étapes de reproduction si disponibles
- Votre OneSignal App ID
- L’External ID ou le Subscription ID le cas échéant
- L’URL du message que vous avez testé dans le OneSignal Dashboard le cas échéant
- Tous les journaux ou messages d’erreur pertinents




