Thanks to visit codestin.com
Credit goes to documentation.onesignal.com

​
Overview

This guide explains how to integrate OneSignal push notifications into a Huawei app distributed on the Huawei AppGallery. These instructions are for native apps written in Java or Kotlin. For other supported SDKs see:

Ionic/Cordova/Capacitor

Flutter

React Native

Unity

​
Requirements

  • Android Studio
  • A Huawei device with “Huawei App Gallery” installed
  • Configured OneSignal App and Platform

​
Configure your OneSignal app and platform

Required setup for push notifications To start sending push notifications with OneSignal, you must first configure your OneSignal app with all the platforms your support—Apple (APNs), Google (FCM), Huawei (HMS), and/or Amazon (ADM).
If your organization already has a OneSignal account, ask to be invited as an admin role to configure the app. Otherwise, sign up for a free account to get started.
You can manage multiple platforms (iOS, Android, Huawei, Amazon, Web) under a single OneSignal app.
1

Create or select your app

  • To add platforms to an existing app, go to Settings > Push & In-App in the OneSignal dashboard.
  • To start fresh, click New App/Website and follow the prompts.

Example shows creating a new app.

2

Set up and activate a platform

  • Choose a clear and recognizable name for your app and organization.
  • Select the platform(s) you want to configure (iOS, Android, etc.).
  • Click Next: Configure Your Platform.

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 the SDK that matches your development platform (e.g., iOS, Android, React Native, Unity), then click Save & Continue.

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

5

Install SDK and save your App ID

Once your platform is configured, your OneSignal App ID will be displayed. Copy and save this ID—you’ll need it when installing and initializing the SDK.If collaborating with others, use the Invite button to add developers or teammates, then click Done to complete setup.

Save your App ID and invite additional team members.

Once complete, follow the SDK installation guide for your selected platform to finish integrating OneSignal.

​
Setup

​
1. Setup the OneSignal SDK

OneSignal Android SDK setup

Follow the OneSignal Android SDK setup guide to implement our SDK into your app. Note that Firebase/Google setup is not required for app builds released to the Huawei AppGallery.

​
2. Huawei configuration (agconnect-services.json)

You can skip this step if you already have a Huawei agconnect-services.json in your Android Studio Project from setting up a different Huawei service.
From the AppGallery Connect Project List select your app. Click on the “agconnect-services.json” button to download this file.
Place this file in your app directory in Android Studio.

​
3. Generating a signing certificate fingerprint

You can skip this step if you already have added your SHA-256 certificate fingerprint to Huawei’s dashboard for a different Huawei service.
From your Android Studio go to View > Tool Windows > Gradle.
From here select app > Tasks > android > signingReport.
Copy your SHA-256 for your release variant.
  • Optional but recommended for quicker testing is the SHA-256 for your debug variant too.
  • You may have other custom variants in your project, if you need push support for them copy these as well.
From the AppGallery Connect Project List select your app. Scroll to the bottom to find the “SHA-256 certificate fingerprint” field were you should enter your keys.

​
4. Add Huawei gradle plugin and dependencies

Open your root build.gradle (Project: ) in Android Studio and add maven {url 'https://developer.huawei.com/repo/'} under buildscript { repositories } and allprojects { repositories }
Under buildscript { dependencies } add classpath 'com.huawei.agconnect:agcp:1.9.1.301' You should have in total 3 new lines in your root build.gradle, highlighted below.
Open your app/build.gradle file and add implementation 'com.huawei.hms:push:6.3.0.304' under the dependencies section. Also to the app/build.gradle file add apply plugin: 'com.huawei.agconnect' to the very bottom of the file. You should have in total 2 new lines in your app/build.gradle, highlighted below.
Make sure to press “Sync Now” on the banner that pops up after saving!

​
Additional configuration steps

​
Compatibility with other HMS push libraries or your own HmsMessageService class

Required if:
  • You have another HMS push SDK/Library in your app in-addition to OneSignal
  • You have your own HmsMessageService
Create a class that extends from HmsMessageService, if you don’t have one already and add the following methods.
If you already had a class that extends HmsMessageService please add the two new OneSignalHmsEventBridge lines instead of creating another class.
Java
public class YourHmsMessageService extends HmsMessageService {
  public void onNewToken(String token) {
      // ...
      // Forward event on to OneSignal SDK
      OneSignalHmsEventBridge.onNewToken(this, token);
  }

  @Override
  public void onMessageReceived(RemoteMessage message) {
      // ...
      // Forward event on to OneSignal SDK
      OneSignalHmsEventBridge.onMessageReceived(this, message);
  }
}
This is to forward onNewToken and onMessageReceived to OneSignal via the OneSignalHmsEventBridge.If you didn’t have a class that extended HmsMessageService before make sure to add it to your AndroidManifest.xml under the <application> tag.
AndroidManifest.xml
<application>
    ...

    <!--
      Ensure you only have one intent-filter for "com.huawei.push.action.MESSAGING_EVENT".
      HMS only supports one per app.
    -->
    <service
        android:name=".YourHmsMessageService"
        android:exported="false">
        <intent-filter>
            <action android:name="com.huawei.push.action.MESSAGING_EVENT" />
        </intent-filter>
    </service>

    ...
</application>

​
Omit Google libraries for Huawei AppGallery builds (optional)

If your app will only be available on the Huawei AppGallery and you want to omit any Google related dependencies that OneSignal includes you can use exclude with implementation in your app/build.gradle.
implementation('com.onesignal:OneSignal:[5.0.0-beta, 5.99.99]') {
    exclude group: 'com.google.android.gms'
    exclude group: 'com.google.firebase'
}

​
Prefer HMS over FCM (optional)

If you have omitted Google Libraries for Huawei AppGallery build above, this step doesn’t apply.By default OneSignal prefers using FCM over HMS if both are included in your app. If you like to change this to prefer HMS instead you can add the following to your AndroidManifest.xml:
<application>
        ...
        <meta-data android:name="com.onesignal.preferHMS" android:value="true"/>
        ...
 </application>

​
Huawei troubleshooting

While testing, make sure to keep the OneSignal setLogLevel method set to VERBOSE. Check the logs to see any errors being thrown and Huawei Common Error Codes.
You may need to create a debug or release keystore signature (choose the correct app build path, debug or release) so that a 6003 error is avoided when registering for Huawei pushToken with the OneSignal SDK. See “Configure a Signature” section
"notification_types":-25 means OneSignal timed out waiting for a response from Huawei’s HMS to get a push token. This is most likely due to another 3rd-party HMS push SDK or your own HmsMessageService getting this event instead of OneSignal.Please review step on how to check this and forward the event if this is the case.
This means there is a class HMS is missing from the app that is needed for push. Just having com.huawei.hms:push in the build.gradle will cause this specific error not to happen any more. However, if you have some aggressive Proguard or R8 settings, this might cause issues. We recommend turn off minifyEnabled temporary if you have it to see if that is the root of the issue.Also, you shouldn’t mix and match major release versions of other HMS libraries. Start with either 4 or 5. Make sure not to have a mixture from 3 to 5 which is going to create other errors
E/OneSignal: HMS ApiException getting Huawei push token!
    com.huawei.hms.common.ApiException: -5: Core error
Check your Proguard or R8 rules to make sure they are setup properly. Possibly disable it temporarily to see if it is related. If it fixes the issue after disabling Proguard or R8 then you can follow this guide and turn it back on See “Configure a Signature” section

​
Testing the OneSignal SDK integration

This guide helps you verify that your OneSignal SDK integration is working correctly by testing push notifications, subscription registration, and in-app messaging.

​
Check mobile subscriptions

1

Launch your app on a test device.

The native push permission prompt should appear automatically if you added the requestPermission method during initialization.

iOS and Android push permission prompts

2

Check your OneSignal dashboard

Before accepting the prompt, check the OneSignal dashboard:
  • Go to Audience > Subscriptions.
  • You should see a new entry with the status “Never Subscribed”.

Dashboard showing subscription with 'Never Subscribed' status

3

Return to the app and tap Allow on the prompt.

4

Refresh the OneSignal dashboard Subscription's page.

The subscription’s status should now show Subscribed.

Dashboard showing subscription with 'Subscribed' status

You have successfully created a mobile subscription. Mobile subscriptions are created when users first open your app on a device or if they uninstall and reinstall your app on the same device.

​
Set up test subscriptions

Test subscriptions are helpful for testing a push notification before sending a message.
1

Add to Test Subscriptions.

In the dashboard, next to the subscription, click the Options (three dots) button and select Add to Test Subscriptions.

Adding a device to Test Subscriptions

2

Name your subscription.

Name the subscription so you can easily identify your device later in the Test Subscriptions tab.

Dashboard showing the 'Name your subscription' field

3

Create a test users segment.

Go to Audience > Segments > New Segment.
4

Name the segment.

Name the segment Test Users (the name is important because it will be used later).
5

Add the Test Users filter and click Create Segment.

Creating a 'Test Users' segment with the Test Users filter

You have successfully created a segment of test users. We can now test sending messages to this individual device and groups of test users.

​
Send test push via API

1

Get your App API Key and App ID.

In your OneSignal dashboard, go to Settings > Keys & IDs.
2

Update the provided code.

Replace YOUR_APP_API_KEY and YOUR_APP_ID in the code below with your actual keys. This code uses the Test Users segment we created earlier.
curl -X \
POST --url 'https://api.onesignal.com/notifications' \
 --header 'content-type: application/json; charset=utf-8' \
 --header 'authorization: Key YOUR_APP_API_KEY' \
 --data \
 '{
  "app_id": "YOUR_APP_ID",
  "target_channel": "push",
  "name": "Testing basic setup",
  "headings": {
  	"en": "👋"
  },
  "contents": {
    "en": "Hello world!"
  },
  "included_segments": [
    "Test Users"
  ],
  "ios_attachments": {
    "onesignal_logo": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
  },
  "big_picture": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
}'
3

Run the code.

Run the code in your terminal.
4

Check images and confirmed delivery.

If all setup steps were completed successfully, the test subscriptions should receive a notification with an image included:

Push notification with image on iOS and Android

Images will appear small in the collapsed notification view. Expand the notification to see the full image.
5

Check for confirmed delivery.

In your dashboard, go to Delivery > Sent Messages, then click the message to view stats.You should see the confirmed stat, meaning the device received the push.

Delivery stats showing confirmed delivery

If you’re on a Professional plan or higher, scroll to Audience Activity to see subscription-level confirmation:

Confirmed delivery at the device level in Audience Activity

You have successfully sent a notification via our API to a segment.
  • No image received? Your Notification Service Extension might be missing.
  • No confirmed delivery? Review the troubleshooting guide here.
  • Having issues? Copy-paste the api request and a log from start to finish of app launch into a .txt file. Then share both with [email protected].

​
Send an in-app message

In-app messages let you communicate with users while they are using your app.
1

Close or background your app on the device.

This is because users must meet the in-app audience criteria before a new session starts. In OneSignal, a new session starts when the user opens your app after it has been in the background or closed for at least 30 seconds. For more details, see our guide on how in-app messages are displayed.
2

Create an in-app message.

  • In your OneSignal dashboard, navigate to Messages > In-App > New In-App.
  • Find and select the Welcome message.
  • Set your Audience as the Test Users segment we used previously.

Targeting the 'Test Users' segment with an in-app message

3

Customize the message content if desired.

Example customization of in-app Welcome message

4

Set Trigger to 'On app open'.

5

Schedule frequency.

Under Schedule > How often do you want to show this message? select Every time trigger conditions are satisfied.

In-app message scheduling options

6

Make message live.

Click Make Message Live so it is available to your Test Users each time they open the app.
7

Open the app and see the message.

After the in-app message is live, open your app. You should see it display:

Welcome in-app message shown on devices

Not seeing the message?
  • Start a new session
    • You must close or background the app for at least 30 seconds before reopening. This ensures a new session is started.
    • For more, see how in-app messages are displayed.
  • Still in the Test Users segment?
    • If you reinstalled or switched devices, re-add the device to Test Subscriptions and confirm it’s part of the Test Users segment.
  • Having issues?
    • Follow Getting a Debug Log while reproducing the steps above. This will generate additional logging that you can share with [email protected] and we will help investigate what’s going on.
You have successfully setup the OneSignal SDK and learned important concepts like:Continue with this guide to identify users in your app and setup additional features.

​
User identification

Previously, we demonstrated how to create mobile Subscriptions. Now we’ll expand to identifying Users across all their subscriptions (including push, email, and SMS) using the OneSignal SDK. We’ll cover External IDs, tags, multi-channel subscriptions, privacy, and event tracking to help you unify and engage users across platforms.

​
Assign External ID

Use an External ID to identify users consistently across devices, email addresses, and phone numbers using your backend’s user identifier. This ensures your messaging stays unified across channels and 3rd party systems (especially important for Integrations). Set the External ID with our SDK’s login method each time they are identified by your app.
OneSignal generates unique read-only IDs for subscriptions (Subscription ID) and users (OneSignal ID).As users download your app on different devices, subscribe to your website, and/or provide you email addresses and phone numbers outside of your app, new subscriptions will be created.Setting the External ID via our SDK is highly recommended to identify users across all their subscriptions, regardless of how they are created.

​
Add data tags

Tags are key-value pairs of string data you can use to store user properties (like username, role, or preferences) and events (like purchase_date, game_level, or user interactions). Tags power advanced Message Personalization and Segmentation allowing for more advanced use cases. Set tags with our SDK addTag and addTags methods as events occur in your app. In this example, the user reached level 6 identifiable by the tag called current_level set to a value of 6.

A user profile in OneSignal with a tag called "current_level" set to "6"

We can create a segment of users that have a level of between 5 and 10, and use that to send targeted and personalized messages:

Segment editor showing a segment targeting users with a current_level value of greater than 4 and less than 10


Screenshot showing a push notification targeting the Level 5-10 segment with a personalized message


The push notification is received on an iOS and Android device with the personalized content

​
Add email and/or SMS subscriptions

Earlier we saw how our SDK creates mobile subscriptions to send push and in-app messages. You can also reach users through emails and SMS channels by creating the corresponding subscriptions. If the email address and/or phone number already exist in the OneSignal app, the SDK will add it to the existing user, it will not create duplicates. You can view unified users via Audience > Users in the dashboard or with the View user API.

A user profile with push, email, and SMS subscriptions unified by External ID

Best practices for multi-channel communication
  • Obtain explicit consent before adding email or SMS subscriptions.
  • Explain the benefits of each communication channel to users.
  • Provide channel preferences so users can select which channels they prefer.
To control when OneSignal collects user data, use the SDK’s consent gating methods: See our Privacy & security docs for more on:

​
Prompt for push permissions

Instead of calling requestPermission() immediately on app open, take a more strategic approach. Use an in-app message to explain the value of push notifications before requesting permission. For best practices and implementation details, see our Prompt for push permissions guide.

​
Listen to push, user, and in-app events

Use SDK listeners to react to user actions and state changes. The SDK provides several event listeners for you to hook into. See our SDK reference guide for more details.

​
Push notification events

For full customization, see Mobile Service Extensions.

​
User state changes

​
In-app message events

​
Advanced setup & capabilities

Explore more capabilities to enhance your integration:

​
Mobile SDK setup & reference

Make sure you’ve enabled all key features by reviewing the Mobile push setup guide. For full details on available methods and configuration options, visit the Mobile SDK reference.
Congratulations! You’ve successfully completed the Mobile SDK setup guide.
Need help?Chat with our Support team or email [email protected]Please include:
  • Details of the issue you’re experiencing and steps to reproduce if available
  • Your OneSignal App ID
  • The External ID or Subscription ID if applicable
  • The URL to the message you tested in the OneSignal Dashboard if applicable
  • Any relevant logs or error messages
We’re happy to help!