​

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:

​

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).

​

Setup

​

1. Setup the OneSignal SDK

​

2. Huawei configuration (agconnect-services.json)

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

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.6.5.300'

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.

​

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

​

Omit Google libraries for Huawei AppGallery builds (optional)

​

Prefer HMS over FCM (optional)

​

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.

​

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

​

Set up test subscriptions

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

​

Send test push via API

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"
}'

​

Send an in-app message

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

​

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.

​

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.

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:

​

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.

• Use the addEmail method to create email subscriptions.
• Use the addSms method to create SMS 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.

​

Privacy & user consent

To control when OneSignal collects user data, use the SDK’s consent gating methods:

• setConsentRequired(true): Prevents data collection until consent is given.
• setConsentGiven(true): Enables data collection once consent is granted.

See our Privacy & security docs for more on:

• Data collected by the SDK
• Handling personal data

​

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

• addClickListener(): Detect when a notification is tapped. Helpful for Deep Linking.
• addForegroundLifecycleListener(): Control how notifications behave in foreground.

For full customization, see Mobile Service Extensions.

​

User state changes

• addObserver() for user state: Detect when the External ID is set.
• addPermissionObserver(): Track the user’s specific interaction with the native push permission prompt.
• addObserver() for push subscription: Track when the push subscription status changes.

​

In-app message events

• addClickListener(): Handle in-app click actions. Ideal for deep linking or tracking events.
• addLifecycleListener(): Track full lifecycle of in-app messages (shown, clicked, dismissed, etc.).

​

Advanced setup & capabilities

Explore more capabilities to enhance your integration:

• 🔁 Migrating to OneSignal from another service
• 🌍 Location tracking
• 🔗 Deep Linking
• 🔌 Integrations
• 🧩 Mobile Service Extensions
• 🛎️ Action buttons
• 🌐 Multi-language messaging
• 🛡️ Identity Verification
• 📊 Custom Outcomes
• 📲 Live Activities

​

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.