Guides
Log InSign Up

macOS app setup

Instructions for adding OneSignal to your macOS app

Suggest Edits

Requirements

  • Configured OneSignal App and Platform

Configure your OneSignal app and platform

Required

Before enabling push notifications, make sure your app is set up with the platforms you support— Apple (APNS), Google (FCM), Huawei (HMS), and/or Amazon (ADM). Follow the steps below to configure your OneSignal account and platform settings.

If your team already has a OneSignal account, ask to be invited as an admin role so you can configure the app. Otherwise, sign up for a free account to get started.

Details on configuring your OneSignal app (click to expand)

You can configure multiple platforms (iOS, Android, Huawei, Amazon) within a single OneSignal app.

1. Create or select your app

  • Select your app and go to Settings > Push & In-App to add platforms to an existing app.
  • Or create a new app by clicking New App/Website.
Example shows creating a new app.

Example shows creating a new app.

2. Set up and activate a platform

  • If creating an app, choose a recognizable app and organization name.
  • Select a platform to activate.
  • Click Next: Configure Your Platform.
Example setting up your first OneSignal app, org, and channel.

Example setting up your first OneSignal app, org, and channel.

3. Configure platform credentials

Follow the prompts based on your platforms:

Click Save & Continue after entering your credentials.

4. Choose target SDK

Select your app's target SDK and click Save & Continue.

Select which SDK you are using to be navigated to the docs.

Select which SDK you are using to be navigated to the docs.

5. Install SDK and save your App ID

You’ll be shown your OneSignal App ID — make sure to save it, as you’ll need it during SDK installation.

If needed, invite a teammate or developer by clicking Invite, then click Done.

Save your App ID for SDK setup and invite any more team members.

Save your App ID for SDK setup and invite any more team members.


Continue through the rest of our documentation to complete the integration.

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 our Create user endpoint with a subscription type of macOSPush to represent the macOS platform, and pass in the push token for the token parameter.

Updating user events

With the Create user or Update user APIs you can set your own custom alias or external_id and update user data.

Send messages

You can send push notifications using the OneSignal dashboard or Create notification API. More details, see Sending Push Messages.

Updated 6 months ago

What’s Next