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

macOS App Setup

Instructions for adding OneSignal to your macOS app

Required For Setup

macOS Setup

Option 1: Mac Catalyst

If you built your app with Mac Catalyst, you can setup OneSignal's XCFramework SDK.

More details in this guide on our blog.

Option 2: API

OneSignal does not currently have a dedicated macOS SDK. However, OneSignal can be used to send notifications to macOS apps. Please refer to Apple's documentation to learn how to obtain a push token.

To register a macOS device, call OneSignal's Add a Device POST /players with a device_type of 9 to represent the macOS platform, and pass in the push token for the identifier parameter.

Updating User Events

With the Add a Device POST /players you can set your own custom external_user_id and update custom data (called Data Tags with the Edit tags with external user id.

Otherwise, you can save the OneSignal player_id provided in the response to update device data with Edit device or New session.

Updated 7 months ago

macOS App Setup

Instructions for adding OneSignal to your macOS app

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.