Overview

Use this API to create a new OneSignal app. This is helpful if you need to create multiple apps and don't want to login to the dashboard to do so. The app can be created in an existing organization or this will create a new organization. The push platform configuration settings for web and mobile can also be populated during app creation using this API.

See Apps & Organizations for more about OneSignal apps and organizations.

How to use this API

Using your Organization API key (available in Organizations > Keys & IDs) you can create a new OneSignal app. The Organization API key is not the same as the REST API key.

The name and organization_id are required.

The name is what you want to call the app. You can get the Organization ID from your OneSignal dashboard.

You can include some or all of the parameters for your apps push platform settings in order to set up push immediately, but the email and SMS platform settings must be configured through the OneSignal dashboard. See below for a list of platform specific settings for web, Android, and iOS push notifications.

Web push configuration

Required: site_name, chrome_web_origin, safari_site_origin

Use site_name to set the specific origin URL for your website, and include https://. You should also set the chrome_web_origin and safari_site_origin to the same value and all three must be set in the same request.

Recommended: chrome_web_default_notification_icon, safari_icon_256_256

Use the chrome_web_default_notification_icon and safari_icon_256_256 parameters to set the default icon for web push notifications. These parameters should be set to the URL of a 256x256px png image. See our web push setup guide for more details and examples of where this icon is displayed.

Other : safari_apns_p12, safari_apns_p12_password

You can set your push notification p12 certificate file for Safari Push Notifications using these parameters. The value for safari_apns_p12 should be your p12 certificate converted to base64 encoded format and the value for safari_apns_p12_password should be the password for the same file. For details on how to generate a p12 file, please see our p12 guide .

These parameters are entirely optional and they if not provided we will assign a p12 to your account for you. If using your own p12, you will need to include both the base64 encoded certificate and the password in the same request.

Android mobile push configuration

Required: fcm_v1_service_account_json

This parameter should be set to your FCM Service Account Private Key JSON file, converted to base64 format. See our Android: Firebase Credentials guide for details on how to generate the Private Key JSON file.

iOS mobile push configuration

iOS mobile push can be configured using either a p8 or a p12 authentication.

Required if using p8: apns_key_id, apns_team_id, apns_bundle_id, apns_p8

The apns_p8 should be your p8 key file converted to base64 encoded format. you can download your p8 key and retrieve your apns_key_id, apns_team_id, and apns_bundle_id from your Apple developer account by following our p8 configuration guide.

Required if using p12: apns_p12, apns_p12_password

The value for safari_apns_p12 should be your p12 certificate converted to base64 encoded format and the value for safari_apns_p12_password should be the password for the same file. For details on how to generate a p12 file, please see our p12 guide .

Type boolean

Description

iOS: Allows iOS push notification data values to be added to the root of the aps payload when sent to the iOS device. Only used for special cases. Omit this value unless you use other push SDKs or not using OneSignal SDK methods to read the payload.