Requisitos
- Plano Flutterflow: Standard ou superior
- App OneSignal e plataforma configurados
- macOS com Xcode 14+ (instruções de configuração usam Xcode 16.2)
- Dispositivo com iOS 12+, iPadOS 12+, ou simulador Xcode executando iOS 16.2+
- CocoaPods 1.16.2+
- Dispositivo ou emulador Android 7.0+ com Google Play Store (Services) instalado
Configure your OneSignal app and platform
Configure your OneSignal app with the platforms you support — Apple (APNs), Google (FCM), Huawei (HMS), and/or Amazon (ADM).If your organization already has a OneSignal account, ask to be invited to the Organization. Otherwise, sign up for a free account to get started.
Step-by-step setup instructions
Step-by-step setup instructions
Create or select your app
Create a new app by clicking New App/Website, or add a platform to an existing app in Settings > Push & In-App. Select the platform(s) you want to configure and click Next: Configure Your Platform.

Configure platform credentials
Enter the credentials for your platform:
- Android: Set up Firebase credentials
- iOS: p8 token (recommended) or p12 certificate
- Amazon: Generate API key
- Huawei: Authorize OneSignal
Configuração
1. Criar uma nova ação personalizada
No seu projeto Flutterflow, navegue até Custom Code, depois clique no botão +Add e selecione Action.
dependency

YOUR_APP_ID pelo seu ID de App OneSignal encontrado no painel OneSignal Configurações > Chaves e IDs.
Se você não tem acesso ao app OneSignal, peça aos seus Membros da Equipe para convidá-lo.
Flutter
onesignal que acabou de ser criada.


2. Exportar o projeto
- Download do APK (somente Android)
- Download completo do projeto (iOS e Android)
Abra o Developer Menu e baixe o APK:
Depois que o APK for baixado, você pode testar o aplicativo arrastando o APK para um emulador Android para instalá-lo. Os recursos push devem funcionar imediatamente e você pode enviar notificações push para o dispositivo assim que fornecer permissões push por meio do prompt nativo.

3. Configuração iOS
O projeto baixado provavelmente não estará pronto para ser executado no iOS. Antes de configurar as adições específicas do OneSignal, você precisará certificar-se de que o projeto está totalmente compilado. Para fazer isso:- Abra uma janela do Terminal, cd (mudar diretório) para a pasta
iosdo seu projeto baixado. - No Terminal, digite
flutter build iose pressione enter. Aguarde a conclusão da compilação, isso pode levar algum tempo dependendo do tamanho do seu projeto. - Ainda no Terminal, digite
pod installe pressione enter. Aguarde a conclusão da instalação do pod.
.xcworkspace no Xcode localizado na pasta ios do seu projeto.
Selecione o projeto raiz > seu app target principal > Signing & Capabilities.
Se você não ver Push Notifications habilitado, clique em + Capability e adicione Push Notifications. Certifique-se de inserir os detalhes corretos para seu Team e Bundle Identifier.


Adicionar Notification Service Extension
O OneSignalNotificationServiceExtension permite que seu aplicativo iOS receba notificações ricas com imagens, botões e badges. Também é necessário para os recursos de análise de Confirmed Delivery do OneSignal. No Xcode, selecione File > New > Target… Selecione Notification Service Extension e depois Next.
OneSignalNotificationServiceExtension e pressione Finish.



Adicionar App Groups
App Groups permitem que seu aplicativo e o OneSignalNotificationServiceExtension se comuniquem quando uma notificação é recebida, mesmo que seu aplicativo não esteja ativo. Isso é necessário para badges e Confirmed Deliveries. Selecione seu Main App Target > Signing & Capabilities > + Capability > App Groups.
group.YOUR_BUNDLE_IDENTIFIER.onesignal onde YOUR_BUNDLE_IDENTIFIER é o mesmo que o “Bundle Identifier” do seu Main Application.


group.YOUR_BUNDLE_IDENTIFIER.onesignal onde YOUR_BUNDLE_IDENTIFIER é o mesmo que o “Bundle Identifier” do seu Main Application.
NÃO INCLUA OneSignalNotificationServiceExtension.

Instruções opcionais para configurar nome personalizado do App Group
Instruções opcionais para configurar nome personalizado do App Group
Esta etapa só é necessária se você não quiser usar o nome padrão do app group (que é
group.{your_bundle_id}.onesignal).Abra seu arquivo Info.plist e adicione uma nova OneSignal_app_groups_key como tipo String.Insira o nome do grupo que você marcou na última etapa como seu valor.Certifique-se de fazer o mesmo para o Info.plist na pasta OneSignalNotificationServiceExtension.Adicionar SDK OneSignal ao OneSignalNotificationServiceExtension
Atualize seuios/Podfile para incluir:
Podfile, certifique-se de ter platform :ios, '11.0'. - Ou uma versão mais recente do iOS se seu aplicativo exigir.
cd para o diretório ios e execute pod install.
Se você vir o erro abaixo, adicione use_frameworks! no topo do seu podfile e tente novamente.
Código do OneSignalNotificationServiceExtension
No navegador de projetos do Xcode, selecione a pasta OneSignalNotificationServiceExtension e abra o arquivoNotificationService.m ou NotificationService.swift.
Substitua todo o conteúdo do arquivo pelo seguinte código.

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
Launch your app on a test device.
The native push permission prompt should appear automatically if you added the 
requestPermission method during initialization.
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”.

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
Test subscriptions are helpful for testing a push notification before sending a message.Add to Test Subscriptions.
In the dashboard, next to the subscription, click the Options (three dots) button and select Add to Test Subscriptions.

Name your subscription.
Name the subscription so you can easily identify your device later in the Test Subscriptions tab.
Name the segment.
Name the segment
Test Users (the name is important because it will be used later).Send test push via API
Get your App API Key and App ID.
In your OneSignal dashboard, go to Settings > Keys & IDs.
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.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.
Send an in-app message
In-app messages let you communicate with users while they are using your app.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.
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.

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

Make message live.
Click Make Message Live so it is available to your Test Users each time they open the app.
You have successfully setup the OneSignal SDK and learned important concepts like:
- Gathering Subscriptions, setting Test subscriptions, and creating Segments.
- Sending Push with images and Confirmed Delivery using Segments and our Create message API.
- Sending In-app messages.
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’slogin 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 Tags
Tags are key-value pairs of string data you can use to store user properties (likeusername, 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.




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
addEmailmethod to create email subscriptions. - Use the
addSmsmethod to create SMS subscriptions.

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.
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.
Prompt for push permissions
Instead of callingrequestPermission() 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.
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.Congratulations! You’ve successfully completed the Mobile SDK setup guide.




