Configuración del SDK de Flutterflow

​

Requisitos

• Plan Flutterflow: Standard o superior
• Aplicación y plataforma de OneSignal configuradas

• macOS con Xcode 14+ (las instrucciones de configuración usan Xcode 16.2)
• Dispositivo con iOS 12+, iPadOS 12+ o simulador de Xcode ejecutando iOS 16.2+
• CocoaPods 1.16.2+

• Dispositivo Android 7.0+ o emulador con Google Play Store (Services) instalado

​

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.

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.

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.

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.

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

​

Configuración

​

1. Crear una nueva acción personalizada

  dependencies:
  	onesignal_flutter: ^5.1.2

  import 'package:onesignal_flutter/onesignal_flutter.dart';

  Future onesignal() async {
    //Remove this method to stop OneSignal Debugging
    OneSignal.Debug.setLogLevel(OSLogLevel.verbose);

    OneSignal.initialize("YOUR_APP_ID");

    // The promptForPushNotificationsWithUserResponse function will show the iOS or Android push notification prompt. We recommend removing the following code and instead using an In-App Message to prompt for notification permission
    OneSignal.Notifications.requestPermission(true);
  }

​

2. Exportar el proyecto

• Descarga de APK (solo Android)
• Descarga de proyecto completo (iOS y Android)

Abre el Developer Menu y descarga el APK:

Una vez que el APK se haya descargado, puedes probar la aplicación arrastrando el APK a un emulador Android para instalarlo. Las capacidades push deberían funcionar de inmediato y puedes enviar notificaciones push al dispositivo tan pronto como proporciones permisos push a través del prompt nativo.

Abre el Developer Menu y descarga el código del proyecto:

​

3. Configuración de iOS

• Abre una ventana de Terminal, cd (cambiar directorio) a la carpeta ios de tu proyecto descargado.
• En Terminal escribe flutter build ios y presiona enter. Espera a que la compilación se complete, esto puede tomar algún tiempo dependiendo del tamaño de tu proyecto.
• Todavía en Terminal escribe pod install y presiona enter. Espera a que la instalación del pod se complete.

​

Agregar Notification Service Extension

​

Agregar App Groups

​

Agregar SDK de OneSignal a la OneSignalNotificationServiceExtension

target 'OneSignalNotificationServiceExtension' do
  pod 'OneSignalXCFramework', '>= 5.0.0', '< 6.0'
end

# Uncomment this line to define a global platform for your project
platform :ios, '11.0'

- Runner (true) and OneSignalNotificationServiceExtension (false) do not both set use_frameworks!.

​

Código de OneSignalNotificationServiceExtension

import UserNotifications

import OneSignalExtension

class NotificationService: UNNotificationServiceExtension {

    var contentHandler: ((UNNotificationContent) -> Void)?
    var receivedRequest: UNNotificationRequest!
    var bestAttemptContent: UNMutableNotificationContent?

    override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
        self.receivedRequest = request
        self.contentHandler = contentHandler
        self.bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)

        if let bestAttemptContent = bestAttemptContent {
            /* DEBUGGING: Uncomment the 2 lines below to check this extension is executing
                          Note, this extension only runs when mutable-content is set
                          Setting an attachment or action buttons automatically adds this */
            // print("Running NotificationServiceExtension")
            // bestAttemptContent.body = "[Modified] " + bestAttemptContent.body

            OneSignalExtension.didReceiveNotificationExtensionRequest(self.receivedRequest, with: bestAttemptContent, withContentHandler: self.contentHandler)
        }
    }

    override func serviceExtensionTimeWillExpire() {
        // Called just before the extension will be terminated by the system.
        // Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used.
        if let contentHandler = contentHandler, let bestAttemptContent =  bestAttemptContent {
            OneSignalExtension.serviceExtensionTimeWillExpireRequest(self.receivedRequest, with: self.bestAttemptContent)
            contentHandler(bestAttemptContent)
        }
    }
}

​

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.

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

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.

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.

2

Name your subscription.

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

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.

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.

Copiar

Preguntar a la IA

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:

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.

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

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

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.

3

Customize the message content if desired.

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.

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:

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.

​

User identification

​

Assign External ID

​

Add data tags

​

Add email and/or SMS subscriptions

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

​

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