Mobile Quickstart
How to set up your Mobile App with OneSignal.
If you haven't already, sign up at onesignal.com.
If this is not your first app with OneSignal, click New App/Website. Otherwise, you will see the next page.
Name your app, then select iOS, Android, or Huawei from the platform list. Click Next: Configure Your Platform. Note: If you want to set up more platforms, you will be able to do so later within the app's settings page.
Image showing new app setup to select a platform
Step 1. Platform Setup
Follow the prompts based on the platforms you support.
iOS
Upload your Apple .p12 certificate or .p8 authentication token.
Image showing the Apple iOS Configuration Inputs
Android
Add your firebase project's Server Key and Sender ID. See Generate a Firebase Server Key if you do not have them yet.
Image showing where to add in your Google Android Configuration
Step 2. Choose the Apps target SDK
Example shows Native Android, if using iOS, it would show Native iOS.
Step 3. Install the SDK
Follow the link to "read the documentation" and please copy Your App ID as this will be the ID that allows your mobile application to connect to the app you have created in OneSignal.
Note: if you need to return to this page. It is under Settings > Select your Platform.
All SDK Setup Docs
If you missed the setup guide, use the table below to select the SDK type you need to get started.
SDKs maintained by 3rd Parties or limited support.
| SDK Setup | iOS | Android | Huawei | Amazon Fire |
|---|---|---|---|---|
| Corona / Solar2D | Yes | Yes | No | Yes |
Desktop Platform Support
Step 4. Subscribe and Send Yourself a Notification
Run your app and ensure that you allow notifications. iOS applications must get user consent to send notifications, and Android applications on Android 13+ must also get user consent to send notifications (Older versions of Android will be automatically opted-in). See our Prompting Guide for more details.
Check your OneSignal Dashboard Audience > All Users to see your Device Record and set yourself as a test user.
Setup Complete!
Head over to Messages > New Push to Send your first Push Notification.
Troubleshooting
If running into issues, see our Mobile troubleshooting guide.
If stuck, contact support directly or email [email protected] for help.
For faster assistance, please provide:
- Your OneSignal App Id
- Details, logs, and/or screenshots of the issue.
- Steps to reproduce
Updated about 1 year ago