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

Keys & IDs

Details on your OneSignal App Id, REST API Key, User Auth Key management and manually disabling your app.

This section contains details on the selected OneSignal App:

Option
Details

Public Key used for initialization and app identification.

Private key used for most API calls involved with sending push notifications and updating users.

Details on how to Reset your REST API Key if you feel this key is compromised or made public.

Security - Disable App

Stops messages from being sent but users can still subscribe to your app/site. You must remove the OneSignal code to stop subscription events.

Another type of REST API key used for Account related updates.

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

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.

Resetting your REST API Key

Visit Settings -> Keys & IDs -> On the right side where tip text is displayed, click "reset your API Key".

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.


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.

Updated 22 days ago


Keys & IDs


Details on your OneSignal App Id, REST API Key, User Auth Key management and manually disabling your app.

Suggested Edits are limited on API Reference Pages

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