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

OneSignal API

OneSignal features - About the OneSignal Server REST API

Advanced Topic

OneSignal's server API can be used to:

  1. Programmatically deliver notifications from your server or device to another device.

  2. Add, update, and fetch data for your users without using our mobile or web SDKs.

  3. Export User or Notification data from OneSignal.

Our API covers:

  1. Apps

  2. Players (also known as devices or users)

  3. Notifications

Our API can be accessed using any regular HTTP library of your choice.

The most commonly used methods are:

  • Create notification - creates and sends a notification to any set of users you specify
  • Cancel notification - cancel sending a notification
  • Edit device - add/remove tags on a user or modify other properties. Normally handled automatically by our Client SDK.
  • View apps - view the details of apps on your OneSignal account
  • CSV export - export your user list

You can find our full API Reference here.