Configuración del SDK de Huawei

​

Descripción general

​

Requisitos

• Android Studio
• Un dispositivo Huawei con “Huawei App Gallery” instalada
• Aplicación y Plataforma de OneSignal configuradas

​

Configure your OneSignal app and platform

Step-by-step instructions for configuring your OneSignal app.

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:

• Android: Set up Firebase Credentials
• iOS: p8 Token (Recommended) or p12 Certificate
• Amazon: Generate API Key
• Huawei: Authorize OneSignal

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.

​

Configuración

​

1. Configurar el SDK de OneSignal

​

2. Configuración de Huawei (agconnect-services.json)

​

3. Generar una huella digital de certificado de firma

• Opcional pero recomendado para pruebas más rápidas es el SHA-256 para tu variante debug también.
• Puedes tener otras variantes personalizadas en tu proyecto, si necesitas soporte push para ellas, cópialas también.

​

4. Agregar plugin gradle de Huawei y dependencias

​

Pasos de configuración adicionales

​

Compatibilidad con otras bibliotecas push de HMS o tu propia clase HmsMessageService

• Tienes otro SDK/Biblioteca push de HMS en tu aplicación además de OneSignal
• Tienes tu propia clase HmsMessageService

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);
  }
}

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

​

Omitir bibliotecas de Google para compilaciones de Huawei AppGallery (opcional)

implementation('com.onesignal:OneSignal:[5.0.0-beta, 5.99.99]') {
    exclude group: 'com.google.android.gms'
    exclude group: 'com.google.firebase'
}

​

Preferir HMS sobre FCM (opcional)

<application>
        ...
        <meta-data android:name="com.onesignal.preferHMS" android:value="true"/>
        ...
 </application>

​

Solución de problemas de Huawei

E/OneSignal: HMS ApiException getting Huawei push token!
    com.huawei.hms.common.ApiException: -5: Core error

​

Testing the OneSignal SDK integration

​

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

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.

Copy

Ask AI

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 support@onesignal.com.

​

Send an in-app message

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 support@onesignal.com and we will help investigate what’s going on.

​

User identification

​

Assign External ID

​

Add data tags

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

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

• Use the addEmail method to create email subscriptions.
• Use the addSms method to create SMS subscriptions.

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

​

Privacy & user consent

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

• Data collected by the SDK
• Handling personal data

​

Prompt for push permissions

​

Listen to push, user, and in-app events

​

Push notification events

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

​

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

• 🔁 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