The OSNotification class provides the notification payload data accessible within the SDK notification event listeners.

Push notification payloads cannot exceed 4096 bytes of data. However, the limit is closer to roughly 3500 bytes due to our internal property names.

OSNotification class

The OSNotification class is composed of all getters. The class combines the original OSNotification with data previously on the OSNotificationPayload class into a single large OSNotification class.

OSNotificationAction class

The action the user took on the notification.

OneSignal custom push payload

Each OneSignal SDK has a Notification Event Observer that gets triggered when a push is clicked or received.

On Android, our notification payload contains a "custom" key with a nested "i" value. If the notification payload received does not contain this, our SDK will not process the notification.

On iOS, we also have the same "custom" key with nested "i" value, however because Apple has a standard payload it will show all notification sent to the device. So if you send a push from your old platform to a device, do not send the same notification from OneSignal or the user will get it twice.

For iOS Click Handlers, depending on how you handle notification opens you might have to add a check for "custom": { "i": ""} as well. Or if you have your own format, we recommend checking for yours instead.

Adding notification data to iOS root payload

If you are needing to customize iOS payload, you can set your OneSignal app to include this custom data in the payload using our Update an app method and set additional_data_is_root_payload equal to true

Then any push you send with the data or Additional Data from the dashboard will be available in the APNS payload. For example:

... OneSignal Notification Data
"data": {
   "your-custom-data": "1"
} 

will result in the following sent to the device:

{
    "aps" : {
        "alert" : {
            "title" : "Notification Title",
            "body" : "Notification Body",
        }
    },
    "your-custom-data": "1"
}

Resulting in any additional code checking and handling this your-custom-data key at this location to work.

Additional payload properties

The payload can contain a restoring property which is not currently accessible. If you want to prevent a message from restoring, you should set a low or 0 TTL on your notifications. The OneSignal SDK omits restoring notifications if their TTL has expired.