Windows App SDK Setup

Instructions for adding the OneSignal SDK to your Windows app

Step 1. Requirements

  • OneSignal Account
  • Your OneSignal App Id, available in Settings > Keys & IDs.
  • A Windows Desktop App. OneSignal does not currently have a dedicated Windows UWP SDK available; however, OneSignal can be used to send notifications to Windows apps.

Step 2. Setup

OneSignal does not currently provide a dedicated SDK for Windows Desktop Apps, however, you can leverage our API to create and update device records within OneSignal and send push notifications.

Please refer to Microsoft's documentation for setup steps and to learn how to obtain a push token.

Obtain the Microsoft App's "Package SID" and "Secret Key". Paste them into your OneSignal App's Settings > Windows platform.

To register a Windows device with the Push Token in OneSignal, call OneSignal's Add a device API with a device_type of 6 to represent the Windows WNS platform, and pass in the Push Token for the identifier parameter. You can include any other parameters within this endpoint. We recommend using the external_user_id property to identify the user's record.

It would be recommended to save the OneSignal Player Id generated in the Response or set the external_user_id parameter to track users within your own Database, DMP, & CRM Integration.

Step 3. Send Messages

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


Did this page help you?