# Unity SDK basic integration guide
This guide walks you through integrating the Pushwoosh Unity SDK into your application.
## Prerequisites
## Integration steps
### 1. Add Pushwoosh Unity SDK
Add the following to your `Packages/manifest.json`:
```json title="Packages/manifest.json"
{
"dependencies": {
"com.pushwoosh.unity.core": "6.2.7",
"com.pushwoosh.unity.android": "6.2.7",
"com.pushwoosh.unity.ios": "6.2.7"
},
"scopedRegistries": [
{
"name": "npmjs",
"url": "https://registry.npmjs.org",
"scopes": ["com.pushwoosh"]
}
]
}
```
Add only the platform packages you need. For example, omit `com.pushwoosh.unity.android` if you only target iOS.
In Unity, go to **Window > Package Manager > + > Add package from git URL** and add the following URLs one by one:
```
https://github.com/Pushwoosh/pushwoosh-unity.git?path=com.pushwoosh.unity.core
https://github.com/Pushwoosh/pushwoosh-unity.git?path=com.pushwoosh.unity.android
https://github.com/Pushwoosh/pushwoosh-unity.git?path=com.pushwoosh.unity.ios
```
Download `Pushwoosh.unitypackage` from [GitHub Releases](https://github.com/Pushwoosh/pushwoosh-unity/releases) and import via **Assets > Import Package > Custom Package**.
### 2. Install External Dependency Manager
The SDK requires [External Dependency Manager for Unity (EDM4U)](https://github.com/googlesamples/unity-jar-resolver) to resolve native Android and iOS dependencies.
Add the following scoped registry to your `Packages/manifest.json`:
```json
{
"scopedRegistries": [
{
"name": "package.openupm.com",
"url": "https://package.openupm.com",
"scopes": ["com.google.external-dependency-manager"]
}
]
}
```
Then add the package to your dependencies:
```json
"com.google.external-dependency-manager": "1.2.183"
```
### 3. Initialize the SDK
Create a `PushNotificator.cs` script and attach it to any GameObject in the scene:
```csharp title="PushNotificator.cs"
using UnityEngine;
using System.Collections.Generic;
public class PushNotificator : MonoBehaviour
{
void Start()
{
Pushwoosh.ApplicationCode = "XXXXX-XXXXX";
Pushwoosh.FcmProjectNumber = "XXXXXXXXXXXX";
Pushwoosh.Instance.OnRegisteredForPushNotifications += (token) => {
Debug.Log("Push token: " + token);
};
Pushwoosh.Instance.OnFailedToRegisteredForPushNotifications += (error) => {
Debug.Log("Registration failed: " + error);
};
Pushwoosh.Instance.RegisterForPushNotifications();
}
}
```
Replace:
- `XXXXX-XXXXX` with your Pushwoosh Application Code.
- `XXXXXXXXXXXX` with your Firebase project number (Android only).
### 4. iOS native setup
#### 4.1 Capabilities
After building the iOS project from Unity, open the generated Xcode project and add the following capabilities in **Signing & Capabilities**:
- **Push Notifications**
- **Background Modes** with **Remote notifications** checked
For Time Sensitive Notifications (iOS 15+), also add the **Time Sensitive Notifications** capability.
#### 4.2 Info.plist
Add the [Pushwoosh Device API Token](/developer/api-reference/api-access-token/#device-api-token) to your `Info.plist`:
```xml title="Info.plist"
Pushwoosh_API_TOKEN__PUSHWOOSH_DEVICE_API_TOKEN__
```
#### 4.3 Message delivery tracking
Add a Notification Service Extension target to your Xcode project. This is required for accurate delivery tracking and Rich Media on iOS.
Follow the [native guide](/developer/pushwoosh-sdk/ios-sdk/setting-up-pushwoosh-ios-sdk/basic-integration-guide/#4-message-delivery-tracking) to add the extension target.
### 5. Android native setup
#### 5.1 Add Firebase configuration file
Place the `google-services.json` file into your Unity project's **Assets** directory.
#### 5.2 Add Pushwoosh metadata
Add the [Pushwoosh Device API Token](/developer/api-reference/api-access-token/#device-api-token) to your `Assets/Plugins/Android/AndroidManifest.xml` inside the `` tag:
```xml title="AndroidManifest.xml"
```
### 6. Run the project
1. Build and run the project on your target platform.
2. Grant permission for push notifications when prompted.
3. Go to the Pushwoosh Control Panel and [send a push notification](/product/messaging-channels/push-notifications/send-push-notifications/one-time-push).
## Extended integration
At this stage, you can send and receive push notifications. The sections below cover the core SDK functionality.
### Push notification event listeners
The SDK provides two event listeners for handling push notifications:
- `OnPushNotificationsReceived` — triggered when a push notification arrives
- `OnPushNotificationsOpened` — triggered when a user taps a notification
Set up these listeners during SDK initialization:
```csharp title="PushNotificator.cs"
void Start()
{
Pushwoosh.ApplicationCode = "XXXXX-XXXXX";
Pushwoosh.FcmProjectNumber = "XXXXXXXXXXXX";
Pushwoosh.Instance.OnPushNotificationsReceived += (payload) => {
Debug.Log("Push received: " + payload);
};
Pushwoosh.Instance.OnPushNotificationsOpened += (payload) => {
Debug.Log("Push opened: " + payload);
};
Pushwoosh.Instance.RegisterForPushNotifications();
}
```
### User configuration
Personalize push notifications by identifying users and setting their properties:
```csharp
// Set user ID for cross-device tracking
Pushwoosh.Instance.SetUserId("user-123");
// Set user email
Pushwoosh.Instance.SetEmail("user@example.com");
// Set user with both ID and email
Pushwoosh.Instance.SetUser("user-123", new List { "user@example.com" });
// Set preferred language
Pushwoosh.Instance.SetLanguage("en");
```
### Tags
Tags are key-value pairs assigned to devices, enabling user segmentation and targeted messaging:
```csharp
// String tag
Pushwoosh.Instance.SetStringTag("favorite_category", "electronics");
// Integer tag
Pushwoosh.Instance.SetIntTag("purchase_count", 5);
// List tag
Pushwoosh.Instance.SetListTag("interests", new List