> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.qonversion.io/llms.txt
> Use this file to discover all available pages before exploring further.

# OneSignal

> Send in-app subscription events to OneSignal to win back your subscribers

Qonversion sends mobile subscription events to OneSignal to automate push notifications with special offers to users who cancel a trial or a subscription. A personalized push notification with a special offer to a user who just canceled his trial or subscription can significantly uplift your app's revenue.

## 1. Set up the SDKs

1. Make sure you have OneSignal SDK installed. If you do not have OneSignal integration yet, please use [this documentation](https://documentation.onesignal.com/docs#sdk-guides).

2. Set Qonversion SDKs following [installing the SDKs](install-sdk) guides.

3. Additionally, to attribute events sent from Qonversion, you need to set the same user ID at `_q_custom_user_id` key using the `Qonversion.shared().setProperty` method. Follow the [documentation](user-properties) to learn more about this method.

4. Set the same user ID by using OneSignal SDK:

<CodeGroup>
  ```swift Swift theme={null}
  OneSignal.setExternalUserId("yourSideUserID")
  ```

  ```objectivec Objective-C theme={null}
  [OneSignal setExternalUserId:@"yourSideUserID"];
  ```

  ```java Java theme={null}
  OneSignal.setExternalUserId("yourSideUserID");
  ```

  ```kotlin Kotlin theme={null}
  OneSignal.setExternalUserId("yourSideUserID")
  ```
</CodeGroup>

<Info>
  The `setExternalUserId` method is deprecated in version 5+ of Onesignal SDKs. Instead, the External User ID will now be called External ID and will be used as the default alias for the new `OneSignal.login method`

  See the [User Model Migration Guide](https://documentation.onesignal.com/docs/user-model-migration-guide) for more details.
</Info>

## 2. Configure the OneSignal Integration

1. Get your **OneSignal App ID** following [this documentation](https://documentation.onesignal.com/docs/accounts-and-keys).

2. Navigate to the Integrations section in your Qonversion project, select [OneSignal](https://dash.qonversion.io/app/integration/onesignal), and provide the **App ID** and Save.

<Check>
  ### Done

  Now Qonversion will start sending in-app purchases and subscriptions data to your OneSignal account.
</Check>

## How to Test

To test the integration, create a custom segment using a user tag labeled `q_status` with the desired value. Qonversion sets up a custom tag for users based on their most recent subscription status.

<img src="https://mintcdn.com/qonversion/eOsiYIQAgYr1cnnF/images/docs/85d08a5698e2640299288b3ca59ecfe6db44e42fbbe97357932636251f29693c-CleanShot_2024-08-22_at_21.47.122x.png?fit=max&auto=format&n=eOsiYIQAgYr1cnnF&q=85&s=bd81cf0f65aca6d13ad530f586af9c8a" alt="" width="2104" height="1412" data-path="images/docs/85d08a5698e2640299288b3ca59ecfe6db44e42fbbe97357932636251f29693c-CleanShot_2024-08-22_at_21.47.122x.png" />

## Event Payload

The event names correspond to the OneSignal Tag Values.

Qonversion uses the **q\_status** tag with the event names to add data attributes to your OneSignal users. For example:

<CodeGroup>
  ```json theme={null}
  {
     "tags":{
        "q_status":"trial_converted"
     }
  }
  ```
</CodeGroup>

***

[Mixpanel](mixpanel)

[Pushwoosh](pushwoosh)