Warning: This guide shows how to integrate push notifications using OneSignal. GeneXus does not support or maintain the configuration of this external service. Screenshots, parameters, UI labels, and/or configuration steps in OneSignal may change over time.
This document describes how to obtain the App ID and REST API Key from the OneSignal console. These credentials identify your application in OneSignal and are required to send push notifications.
You must obtain the certificates required by each platform that will receive notifications.
For Android (FCM), OneSignal requires the Firebase Admin SDK private key.
To generate it:
- Go to Firebase Console > Project Settings > Service Accounts.
- Click on Generate new private key.
This downloads a JSON file that you will upload later during the OneSignal platform configuration.
If your application also runs on Apple devices, follow the instructions in HowTo: Configure Push Notifications in Apple Applications (or try OneSignal's Provisionator wizard).
Go to the OneSignal site, enter your user credentials, and log in.
In the OneSignal dashboard, select the + New App/Website option.
Enter a name for your application in OneSignal and select (or create) an Organization.
Choose the platform you want to configure. GeneXus only supports Android and
Apple.
For this example, select Google Android (FCM). Then, click on Next: Configure Your Platform.
Note: First, you must select one. Then you can update your OneSignal app from its settings and add the other one.
Click on Select file and upload the JSON file obtained in step 1 (Firebase), then click on Save & Continue.
In the Select your Target SDK section, choose Native Android and click on Save & Continue.
OneSignal will show an overview page to verify all settings. Copy the value of Your App ID. You will need this value to configure the Notification Provider in GeneXus.
Click on the Done button.
After creating the OneSignal application, open Settings > Keys & IDs and copy the App ID displayed in the App ID section.
Then, in the API Keys section, select + Add Key to create a new key.
Enter a name for the API Authentication Key and click on Create.
Next, click on Copy to Clipboard to copy the API Authentication Key:
Note: Copy the API Authentication Key and store it safely. OneSignal displays this key only once.
Click on Continue to proceed.
Keep the following two values in a secure location: App ID and API Authentication Key. You will need them later.
Note: In OneSignal, this value is called API Authentication Key. This is the value you must enter in GeneXus in the
REST API Key property.
Below is a list of errors that can occur when using Notification Provider API with OneSignal.
- 1: Unknown error. See Error Description for more details.
- 3: OneSignal Object ID is required: Method parameter "OneSignal Object ID" (Provider DeviceId) was not set.
- 4: iOS invalid device token: Device Token specified is not valid.
- 5: "GCMSenderId is required". GCMSenderId must be specified in OneSignalPush Config.
- 6: Device Token is required.
- 7: No channels specified. At least 1 channel must be set.
- 10: "Application ID parameter is Required": ApplicationId must be specified in OneSignalPush Config.
- 11: "REST API Key parameter is Required": RestAPIKey must be specified in OneSignalPush Config.
- 112: Invalid Channel Name: Error code indicating an invalid channel name. A channel name is either an empty string (the broadcast channel) or contains only a-zA-Z0-9_* characters and starts with a letter.
- 114: Invalid Device Token.
- 140: Exceeded_Quota: Error code indicating that an application quota was exceeded.
HowTo: Configure Push Notifications in Android Applications