OneSignal

FREE
By dimashirokov
Updated 10 months ago
Communication
0.2/10
Popularity
57958ms
Latency
-
Success Rate

OneSignal API Documentation

Add push notification service to websites and apps.

View API Details
POSTaddDevice
POSTaddDevicePurchase
POSTcancelNotification
POSTcreateApp
POSTcreateDeviceSession
POSTeditDevice
POSTgetApp
POSTgetApps
POSTgetDevice
POSTgetDevices
POSTgetNotification
POSTgetNotifications
POSTnotificationTest
POSTsendNotification
POSTtrackNotificationOpen
POSTupdateApp
POSTupdateDeviceSessionLength
POSTcreateApp

Creates a new OneSignal app

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
userAuthKeyCREDENTIALS
REQUIREDRequired: REST API keys are used for API calls on a specific app's notifications or devices.
nameSTRING
REQUIREDRequired: The name of your new app, as displayed on your apps list on the dashboard. This can be renamed later.
Optional Parameters
apnsEnvSELECT
OPTIONALOptional: iOS - Either sandbox or production
aapnsP12STRING
OPTIONALOptional: iOS - Your apple push notification p12 certificate file, converted to a string and Base64 encoded.
apnsP12passwordSTRING
OPTIONALOptional: iOS - Password for the apns_p12 file
gcmKeySTRING
OPTIONALOptional: ANDROID - Your Google Push Messaging Auth Key
androidGcmSenderIdSTRING
OPTIONALOptional: ANDROID - Your Google Project number. Also know as Sender ID.
chromeWebOriginSTRING
OPTIONALOptional: CHROME, FIREFOX - The URL to your website. This field is required if you wish to enable web push and specify other web push parameters.
chromeWebDefaultNotificationIconSTRING
OPTIONALOptional: CHROME - Your default notification icon. Should be 80x80 pixels.
chromeWebSubDomainSTRING
OPTIONALOptional: CHROME - A subdomain of your choice in order to support Chrome Web Push on non-HTTPS websites. This field must be set in order for the chrome_web_gcm_sender_id property to be processed.
safariApnsP12STRING
OPTIONALOptional: SAFARI - Your apple push notification p12 certificate file for Safari Push Notifications, converted to a string and Base64 encoded.
safariApnsP12PasswordSTRING
OPTIONALOptional: SAFARI - Password for safari_apns_p12 file
siteNameSTRING
OPTIONALOptional: SAFARI - The URL to your website
safariSiteOriginSTRING
OPTIONALOptional: SAFARI - The hostname to your website including http(s)://
safariIconSTRING
OPTIONALOptional: SAFARI - A url for a 256x256 png notification icon. This is the only Safari icon URL you need to provide.
chromeKeySTRING
OPTIONALOptional: NOT FOR WEB PUSH Your Google Push Messaging Auth Key if you use Chrome Apps / Extensions.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication