OneSignal Help & Documentation

Welcome to the OneSignal New IA developer hub. You'll find comprehensive guides and documentation to help you start working with OneSignal New IA as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Discussions

Team & Keys

OneSignal features - Team and Key management


Dashboard > Settings > Administrators

Each separate OneSignal app can have multiple administrators added to the app. Each administrator you add has full access and control over your app, including the ability to delete the app or even remove you as an administrator.

We do not currently support a permission system or log what actions other administrators take. Please be sure to only add administrators you trust.

Administrators are added per-app and not per-user. The app administrator can only access the app(s) they have been added to, and not the other apps you have access to. This means if you have multiple apps that you want another person to access, you will have to invite them within each app.

Adding Administrators

You can view, add, and remove administrators from Administrators. Administrators are invited to join your app via their email address.

Removing Administrators

It is best to keep track of the admins for each app. If someone leaves your team or company, you should delete them from your OneSignal app ASAP. Simply click "Options" next to the email you want to delete and select "Remove".

Keys & IDs

Dashboard > Settings > Keys & IDs

App ID

Your OneSignal App ID or just App ID, is the main identifier we use to differentiate your app from all other OneSignal apps. You will use this in all your SDK initialization codes and API calls. The App ID should not be treated as private.

REST API Key - App Auth Key

Do not share this key

Treat your REST API Key as though it is a password - do not add it to your app code or public repositories (e.g. github) and do not share it with anyone.

Your App Auth Key, which is your REST API key for app-specific operations (getting users of an app, modifying users, getting notifications, sending notifications) listed in the Keys & IDs section, add an HTTP header with the key Authorization and the value Basic REST_API_KEY, where you should replace REST_API_KEY with your actual APP REST API key.

User Auth Key

Your User Auth Key which can be found in Account manages operations outside of an app (e.g. creating an app). Click on the account dropdown on the top right of your dashboard and scroll down to the User Auth Key section. It is past the section that displays each of your app's auth keys.

Resetting your REST API Key

Visit Settings -> Keys & IDs.

On the right side where tip text is displayed, click "reset your API Key". It is above the icon that says "Read our documentation".

The keys for all your apps are also available all together within the Account section.

Disabling Your App

You may disable your app to prevent new and scheduled notifications from being delivered.

You will still receive new subscribers if you disable the app. You must remove or comment out the OneSignal code to stop new subscriptions.

Apps you manually disable can be instantly re-enabled at any time.

Team & Keys

OneSignal features - Team and Key management

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.