Documentation Index
Fetch the complete documentation index at: https://documentation.onesignal.com/llms.txt
Use this file to discover all available pages before exploring further.
개요
OneSignal React Native 및 Expo SDK를 iOS 및 Android 앱에 통합하기 위한 단계별 가이드입니다. 이 가이드를 마치면 OneSignal로 푸시 알림 및 In-App Message를 보낼 수 있습니다.요구 사항
- 관리형 Expo 앱입니다. bare React Native 앱의 경우 React Native SDK 설정을 참조하세요.
- Expo 개발 빌드
- Expo SDK 53+ (React Native 0.79+), New Architecture 활성화 필요
- EAS CLI (EAS Build 문서)
- 구성된 OneSignal 앱 및 플랫폼
- Xcode 14+가 설치된 macOS (설정 지침은 Xcode 16.2 사용)
- iOS 12+, iPadOS 12+ 장치 또는 iOS 16.2+를 실행하는 Xcode 시뮬레이터
- CocoaPods 1.16.2+
- Google Play Store(서비스)가 설치된 Android 7.0+ 장치 또는 에뮬레이터
OneSignal 앱 및 플랫폼 구성
지원하는 플랫폼(Apple (APNs), Google (FCM), Huawei (HMS), Amazon (ADM))으로 OneSignal 앱을 구성하세요.단계별 설정 지침
단계별 설정 지침
앱 만들기 또는 선택

플랫폼 자격 증명 구성
- Android: Firebase 자격 증명 설정
- iOS: p8 토큰(권장) 또는 p12 인증서
- Amazon: API 키 생성
- Huawei: OneSignal 권한 부여
SDK 설정
1. SDK 추가
Expo CLI를 사용하여 OneSignal Expo 플러그인을 설치합니다.react-native-onesignal 패키지를 추가합니다.
2. 플러그인 구성
app.json(또는 app.config.js)을 엽니다. 다음 설정을 포함해야 합니다.
필수 설정
"bundleIdentifier": OneSignal 앱에서 사용 중인 p8 또는 p12 인증과 일치하는 앱의 번들 식별자입니다."infoPlist":UIBackgroundModes키를["remote-notification"]으로 설정해야 합니다."entitlements"- 테스트의 경우
aps-environment키를"development"로, Testflight 및 App Store 빌드의 경우"production"으로 설정해야 합니다. com.apple.security.application-groups키를["group.${ios.bundleIdentifier}.onesignal"]로 설정해야 합니다.
- 테스트의 경우
"android":package키를 앱의 패키지 이름으로 설정해야 합니다."plugins": 앱의plugins배열입니다. 플러그인[onesignal-expo-plugin]을 플러그인 배열의 맨 위에 추가해야 합니다. 또한 테스트의 경우mode키를"development"로, Testflight 및 App Store 빌드의 경우"production"으로 설정해야 합니다.
추가 플러그인 속성
추가 플러그인 속성
| Prop | 필수 | 설명 |
|---|---|---|
mode | ✅ | APNs 환경 자격을 구성합니다. "development" 또는 "production" — 테스트에는 "development", TestFlight 및 App Store 빌드에는 "production"을 사용합니다. |
devTeam | 사용 중단 | 사용 중단. Expo 설정에 ios.appleTeamId 사용을 권장합니다. appleTeamId가 설정되지 않은 경우 플러그인은 devTeam으로 폴백합니다(예: "91SW8A37CR"). |
iPhoneDeploymentTarget | ❌ | iOS Notification Service Extension을 추가할 때 사용되는 IPHONEOS_DEPLOYMENT_TARGET입니다. Podfile의 최소 iOS 버전과 일치해야 합니다(예: "15.0"). |
smallIcons | ❌ | Android 소형 알림 아이콘에 대한 로컬 경로 배열(흰색, 투명, 96×96px). 이미지가 올바른 리소스 폴더에 자동 배치·크기 조정됩니다. 예: ["./assets/ic_stat_onesignal_default.png"] |
largeIcons | ❌ | Android 대형 알림 아이콘에 대한 로컬 경로 배열(흰색, 투명, 256×256px). 예: ["./assets/ic_onesignal_large_icon_default.png"] |
smallIconAccentColor | ❌ | Android 알림 아이콘 강조 색상의 16진수 값(예: "#FF0000"). |
iosNSEFilePath | ❌ | Objective-C로 작성된 사용자 지정 Notification Service Extension의 로컬 경로. 예: "./assets/NotificationService.m" |
appGroupName | ❌ | 사용자 지정 iOS App Group 이름. 생략 시 기본값은 "group.{ios.bundleIdentifier}.onesignal"입니다(예: "group.com.example.myapp.onesignal2"). |
nseBundleIdentifier | ❌ | NSE 번들 ID 접미사. 전체 번들 ID는 {ios.bundleIdentifier}.{nseBundleIdentifier}입니다. 생략 시 기본값은 OneSignalNotificationServiceExtension입니다. |
disableNSE | ❌ | true이면 iOS NSE가 추가되지 않습니다. 배지, 확인된 전달, 미디어 첨부, 액션 버튼에는 NSE가 필요합니다. 기본 푸시만 필요한 경우에만 비활성화하세요. |
sounds | ❌ | 사용자 지정 알림 사운드의 로컬 경로 배열(.wav만, 30초 이하). iOS 앱 번들과 Android의 res/raw/에 복사됩니다. 예: ["./assets/notification_sound.wav"]. 알림 사운드를 참조하세요. |
3. SDK 초기화
Expo 구조(Traditional App entry 또는 Expo Router)에 따라 다음 옵션을 사용하여 OneSignal을 초기화합니다.- Traditional App Entry
- Expo Router
App.tsx 또는 App.js 파일에서 제공된 메서드를 사용하여 OneSignal을 초기화합니다.OneSignal 대시보드 **Settings > Keys & IDs**에서 찾을 수 있는 OneSignal 앱 ID로 YOUR_APP_ID를 교체하세요.Android 설정
Firebase 자격 증명을 사용하여 Android 플랫폼에 대해 OneSignal 앱이 구성되었는지 확인하세요. 앱 브랜딩과 일치하도록 알림 아이콘을 설정합니다. 이 단계를 건너뛰면 푸시 알림에 기본 벨 아이콘이 표시됩니다. Android용 빌드 이 시점에서 문제 없이 실제 Android 장치 또는 에뮬레이터에서 앱을 빌드하고 실행할 수 있어야 합니다.- 해당하는 경우 iOS 설정을 계속합니다.
- 또는 OneSignal SDK 통합 테스트로 건너뜁니다.
iOS 설정
p8 토큰(권장) 또는 p12 인증서를 사용하여 OneSignal 앱이 iOS 플랫폼에 대해 구성되어 있는지 확인하세요.iOS용 빌드
이제 실제 iOS 장치 또는 iOS 시뮬레이터(16.2+)에서 앱을 빌드하고 실행할 수 있습니다.일반적인 iOS 빌드 오류
Cycle Inside... building could produce unreliable results.
Cycle Inside... building could produce unreliable results.
- Xcode에서
.xcworkspace폴더를 열고 your app target > Build Phases로 이동합니다. - “Embed Foundation Extensions” 또는 **“Embed App Extensions”**라는 단계가 있어야 합니다.
- 이 빌드 단계를 드래그하여 “Run Script” 위로 이동합니다.
- 앱을 빌드하고 실행합니다. 오류가 해결되어야 합니다.


PBXGroup Error
PBXGroup Error
PBXGroup attempted to initialize an object with unknown ISA PBXFileSystemSynchronizedRootGroup from attributes: {"isa"=>"...", "exceptions"=>["//", "..."], "explicitFileTypes"=>{}, "explicitFolders"=>[], "path"=>"OneSignalNotificationServiceExtension", "sourceTree"=>"<group>"}- 오류에서 “path” 아래에 나열된 폴더를 찾습니다.
- Xcode 프로젝트 사이드바에서 폴더를 마우스 오른쪽 버튼으로 클릭합니다.
- Convert to Group을 선택합니다.


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.
requestPermission method during initialization.
Check your OneSignal dashboard
- Go to Audience > Subscriptions.
- You should see a new entry with the status “Never Subscribed”.

Refresh the OneSignal dashboard Subscription's page.

Set up test users
test users are helpful for testing a push notification before sending a message.Add to Test Users.

Name your subscription.
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.
Update the provided code.
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.

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

Make message live.
- Gathering Subscriptions, setting Test Users, 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.
Add 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.

- 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.).
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.support@onesignal.com으로 이메일을 보내주세요.다음을 포함해 주세요:- 발생한 문제의 세부 정보 및 재현 단계(가능한 경우)
- OneSignal 앱 ID
- External ID 또는 Subscription ID(해당하는 경우)
- OneSignal 대시보드에서 테스트한 메시지의 URL(해당하는 경우)
- 관련 로그 또는 오류 메시지



