Unity SDK quick start

Get started with the Pushwoosh Unity SDK using this quick and simple example.

Prerequisites

To integrate the Pushwoosh Unity SDK into your app, you will need the following:

Requirements

• A Pushwoosh account.
• A Pushwoosh project set up in your account.
• For iOS integration:
  • An iOS platform configured to send push notifications. We recommend using the Token-Based Authentication configuration as the simplest approach.
  • During setup, set the Gateway to Sandbox to send pushes to a simulator.
• For Android integration:
  • A configured Android platform
  • The project number(also known as Sender ID) , google-services.json file and package name from your Firebase project.
  • A Firebase project connected to your Android application. Follow the Firebase setup guide if needed.
• Your Pushwoosh Application Code and Pushwoosh Device API Token from the Pushwoosh Control Panel for your application.

Download the example project

Clone the example project repository:

git clone https://github.com/Pushwoosh/pushwoosh-unity-sample.git

Configure the project

Open Assets/Scripts/PushNotificator.cs and set the Pushwoosh initialization values:

Assets/Scripts/PushNotificator.cs

Pushwoosh.ApplicationCode = "XXXXX-XXXXX";
Pushwoosh.FcmProjectNumber = "XXXXXXXXXXXX";

Replace the ApplicationCode and FcmProjectNumber values with your Pushwoosh App Code and Firebase Project Number.

iOS

1. Set the Bundle Identifier

In Unity, go to Edit > Project Settings > Player > iOS > Other Settings and set the Bundle Identifier to your bundle ID (e.g., com.example.pushwoosh).

2. Build and install dependencies

Build the iOS project from Unity. Then navigate to the generated Xcode project directory and install the CocoaPods dependencies:

cd ios && pod install

3. Set the API Token

Open the ios/Unity-iPhone.xcworkspace file in Xcode. In your Info.plist add the Pushwoosh Device API Token:

Info.plist

<key>Pushwoosh_API_TOKEN</key>
<string>__PUSHWOOSH_DEVICE_API_TOKEN__</string>

Android

1. Set the package name

In Unity, go to Edit > Project Settings > Player > Android > Other Settings and set the Package Name to your app’s package name (e.g., com.example.pushwoosh).

2. Add google-services.json

Copy your google-services.json file to the Assets directory in your Unity project.

3. Set the API Token

In your Assets/Plugins/Android/AndroidManifest.xml add the Pushwoosh Device API Token inside the <application> tag:

AndroidManifest.xml

<meta-data android:name="com.pushwoosh.apitoken" android:value="__YOUR_DEVICE_API_TOKEN__" />

Caution

Be sure to give the token access to the correct app in your Pushwoosh Control Panel. Learn more

Run the project

1. Build and run the project.
2. Tap the Register for push notifications button.
3. Grant permission for push notifications. The device will be registered with Pushwoosh.

Send a push notification

Go to the Pushwoosh Control Panel and send a push notification to your registered device.