Configuración del SDK Expo

​

Descripción general

​

Requisitos

• Una app Expo administrada. Para apps React Native simples, consulta Configuración del SDK React Native.
• Expo development build
• Expo SDK 52+ con Nueva Arquitectura habilitada
• EAS CLI (documentación EAS Build)
• App y plataforma de OneSignal configuradas

• macOS con Xcode 14+ (las instrucciones de configuración usan Xcode 16.2)
• Dispositivo con iOS 12+, iPadOS 12+ o simulador Xcode ejecutando iOS 16.2+
• CocoaPods 1.16.2+

• Dispositivo o emulador Android 7.0+ con Google Play Store (Services) instalado

​

Configure your OneSignal app and platform

Step-by-step setup instructions

1

Create or select your app

Create a new app by clicking New App/Website, or add a platform to an existing app in Settings > Push & In-App. Select the platform(s) you want to configure and click Next: Configure Your Platform.

2

Configure platform credentials

Enter the credentials for your platform:

• Android: Set up Firebase credentials
• iOS: p8 token (recommended) or p12 certificate
• Amazon: Generate API key
• Huawei: Authorize OneSignal

Click Save & Continue after entering your credentials.

3

Save your App ID and install the SDK

Your App ID is displayed on the final screen. Copy and save it — you need it when initializing the SDK. Select your SDK platform, then follow the setup guide.

​

Configuración del SDK

​

1. Agregar SDK

npx expo install onesignal-expo-plugin

npm install --save react-native-onesignal

​

2. Configurar el plugin

• "bundleIdentifier": El identificador de paquete de tu app que coincide con la autenticación p8 o p12 que estás usando en tu app de OneSignal.
• "infoPlist": Requiere que la clave UIBackgroundModes esté establecida en ["remote-notification"].
• "entitlements"
  • Requiere que la clave aps-environment esté establecida en "development" para pruebas y "production" para compilaciones Testflight y App Store.
  • Requiere que la clave com.apple.security.application-groups esté establecida en ["group.${ios.bundleIdentifier}.onesignal"].
• "android": Requiere que la clave package esté establecida en el nombre de paquete de tu app.
• "plugins": El array plugins de tu app. Se requiere agregar el plugin [onesignal-expo-plugin] al inicio del array de plugins. También requiere que la clave mode esté establecida en "development" para pruebas y "production" para compilaciones Testflight y App Store.

  {
    "expo": {
      "ios": {
        "bundleIdentifier": "com.yourcompany.yourapp",
        "infoPlist": {
          "UIBackgroundModes": ["remote-notification"]
        },
        "entitlements": {
          "aps-environment": "development",
          "com.apple.security.application-groups": [
            "group.${ios.bundleIdentifier}.onesignal"
          ]
        }
      },
      "android": {
        "package": "com.yourcompany.yourapp"
      },
      "plugins": [
        [
          "onesignal-expo-plugin",
          {
            "mode": "development"
          }
        ]
      ]
    }
  }

​

3. Inicializar SDK

import React, { useEffect } from 'react';
// Incluye el paquete OneSignal
import { OneSignal, LogLevel } from 'react-native-onesignal';

export default function App(): React.JSX.Element {
  // Inicializa OneSignal en useEffect para asegurar que se ejecute solo una vez
  useEffect(() => {
    // Habilita el registro detallado para depuración (eliminar en producción)
    OneSignal.Debug.setLogLevel(LogLevel.Verbose);
    // Inicializa con tu ID de App de OneSignal
    OneSignal.initialize('YOUR_APP_ID');
    // Usa este método para solicitar notificaciones push.
    // Recomendamos eliminar este método después de las pruebas y en su lugar usar Mensajes In-App para solicitar permiso de notificación.
    OneSignal.Notifications.requestPermission(false);
  }, []); // Asegura que esto solo se ejecute una vez al montar la app
}

import React, {useEffect} from 'react';
// Incluye el paquete OneSignal
import {OneSignal, LogLevel} from 'react-native-onesignal';

export default function RootLayout() {
  // Inicializa OneSignal en useEffect para asegurar que se ejecute solo una vez
  useEffect(() => {
    // Habilita el registro detallado para depuración (eliminar en producción)
    OneSignal.Debug.setLogLevel(LogLevel.Verbose);
    // Inicializa con tu ID de App de OneSignal
    OneSignal.initialize('YOUR_APP_ID');
    // Usa este método para solicitar notificaciones push.
    // Recomendamos eliminar este método después de las pruebas y en su lugar usar Mensajes In-App para solicitar permiso de notificación.
    OneSignal.Notifications.requestPermission(false);
  }, []); // Asegura que esto solo se ejecute una vez al montar la app
}

​

Android setup

​

Configuración iOS

​

Compilar para iOS

​

Errores comunes de compilación iOS

Cycle Inside... building could produce unreliable results.

Puedes ver este error al compilar con Xcode 15+, debido a un cambio de configuración predeterminado que afecta sistemas multiplataforma.

1. Abre tu carpeta .xcworkspace en Xcode y navega a tu objetivo de app > Build Phases.
2. Deberías tener una fase llamada “Embed Foundation Extensions” o “Embed App Extensions”.
3. Arrastra y mueve esta fase de compilación a arriba de “Run Script”.
4. Compila y ejecuta tu app. El error debería estar resuelto.

Error PBXGroup

RuntimeError - PBXGroup intentó inicializar un objeto con ISA desconocido PBXFileSystemSynchronizedRootGroup desde atributos: {"isa"=>"...", "exceptions"=>["//", "..."], "explicitFileTypes"=>{}, "explicitFolders"=>[], "path"=>"OneSignalNotificationServiceExtension", "sourceTree"=>"<group>"}

Solución:

1. Encuentra la carpeta listada bajo “path” en el error
2. En la barra lateral del proyecto Xcode, haz clic derecho en la carpeta
3. Selecciona Convert to Group

​

Testing the OneSignal SDK integration

​

Check mobile subscriptions

1

Launch your app on a test device.

The native push permission prompt should appear automatically if you added the requestPermission method during initialization.

2

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”.

3

Return to the app and tap Allow on the prompt.

4

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

1

Add to Test Subscriptions.

In the dashboard, next to the subscription, click the Options (three dots) button and select Add to Test Subscriptions.

2

Name your subscription.

Name the subscription so you can easily identify your device later in the Test Subscriptions tab.

3

Create a test users segment.

Go to Audience > Segments > New Segment.

4

Name the segment.

Name the segment Test Users (the name is important because it will be used later).

5

Add the Test Users filter and click Create Segment.

You have successfully created a segment of test users. We can now test sending messages to this individual device and groups of test users.

​

Send test push via API

1

Get your App API Key and App ID.

In your OneSignal dashboard, go to Settings > Keys & IDs.

2

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.

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"
}'

3

Run the code.

Run the code in your terminal.

4

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.

5

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.

You have successfully sent a notification via our API to a segment.

• No image received? Your Notification Service Extension might be missing.
• No confirmed delivery? Review the troubleshooting guide here.
• Having issues? Copy-paste the api request and a log from start to finish of app launch into a .txt file. Then share both with support@onesignal.com.

​

Send an in-app message

1

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.

2

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.

3

Customize the message content if desired.

4

Set Trigger to 'On app open'.

5

Schedule frequency.

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

6

Make message live.

Click Make Message Live so it is available to your Test Users each time they open the app.

7

Open the app and see the message.

After the in-app message is live, open your app. You should see it display:

Not seeing the message?

• Start a new session
  • You must close or background the app for at least 30 seconds before reopening. This ensures a new session is started.
  • For more, see how in-app messages are displayed.
• Still in the Test Users segment?
  • If you reinstalled or switched devices, re-add the device to Test Subscriptions and confirm it’s part of the Test Users segment.
• Having issues?
  • Follow Getting a Debug Log while reproducing the steps above. This will generate additional logging that you can share with support@onesignal.com and we will help investigate what’s going on.

​

User identification

​

Assign External ID

​

Add Tags

​

Add email and/or SMS subscriptions

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

​

Privacy & user consent

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

• Data collected by the SDK
• Handling personal data

​

Prompt for push permissions

​

Listen to push, user, and in-app events

​

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.).

​

Advanced setup & capabilities

• 🔁 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