Pular para o conteúdo principal
Este guia é para configuração de aplicativos móveis Flutterflow. Se você tem um site Flutterflow, consulte nosso guia de Configuração do SDK Web.

Requisitos

  • Plano Flutterflow: Standard ou superior
  • App OneSignal e plataforma configurados
Requisitos iOS
  • 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+
Requisitos Android
  • Dispositivo ou emulador Android 7.0+ com Google Play Store (Services) instalado

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.

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.
Em Action settings na barra de ferramentas à direita, clique em Add Dependency e insira a seguinte dependência e clique em refresh para adicioná-la à ação:
dependency
  dependencies:
  	onesignal_flutter: ^5.1.2
No Action Code, sob o código pré-carregado, adicione o seguinte, depois salve e compile sua ação. Substitua 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
  import 'package:onesignal_flutter/onesignal_flutter.dart';

  Future onesignal() async {
    //Remova este método para parar a Depuração do OneSignal
    OneSignal.Debug.setLogLevel(OSLogLevel.verbose);

    OneSignal.initialize("YOUR_APP_ID");

    // A função promptForPushNotificationsWithUserResponse mostrará o prompt de notificação push iOS ou Android. Recomendamos remover o código a seguir e usar uma Mensagem In-App para solicitar permissão de notificação
    OneSignal.Notifications.requestPermission(true);
  }
Em seguida, clique no arquivo main.dart na barra de ferramentas à esquerda e clique no ícone + ao lado de Initial Actions na barra à direita e clique na ação onesignal que acabou de ser criada.
Isso adicionará a ação ao seu aplicativo e fará com que o SDK OneSignal seja inicializado quando o aplicativo for executado:

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 ios do seu projeto baixado.
  • No Terminal, digite flutter build ios e 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 install e pressione enter. Aguarde a conclusão da instalação do pod.
Abra o arquivo .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.
Clique em + Capability novamente e adicione Background Modes. Em seguida, marque Remote notifications.

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.
Insira o nome do produto como OneSignalNotificationServiceExtension e pressione Finish.
Não ative o esquema no diálogo que é mostrado após selecionar Finish. Pressione Cancel no prompt “Activate scheme”.

Ao cancelar, você continua depurando seu aplicativo em vez da extensão que acabou de criar. Se você ativou por acidente, pode voltar a depurar seu app target perto do meio-topo ao lado do seletor de dispositivo.

Selecione o target OneSignalNotificationServiceExtension e configurações General. Defina Minimum Deployments para ser o mesmo valor do seu Main Application Target. Deve ser iOS 11 ou superior.

Este deve ser o mesmo valor do seu Main Application Target.

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.
Dentro de App Groups, clique no botão +. Defina o container App Groups como group.YOUR_BUNDLE_IDENTIFIER.onesignal onde YOUR_BUNDLE_IDENTIFIER é o mesmo que o “Bundle Identifier” do seu Main Application.
Pressione OK e repita para o OneSignalNotificationServiceExtension Target. Selecione o OneSignalNotificationServiceExtension Target > Signing & Capabilities > + Capability > App Groups.
Dentro de App Groups, clique no botão +. Defina o container App Groups como group.YOUR_BUNDLE_IDENTIFIER.onesignal onde YOUR_BUNDLE_IDENTIFIER é o mesmo que o “Bundle Identifier” do seu Main Application. NÃO INCLUA OneSignalNotificationServiceExtension.

Não inclua OneSignalNotificationServiceExtension

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 seu ios/Podfile para incluir:
target 'OneSignalNotificationServiceExtension' do
  pod 'OneSignalXCFramework', '>= 5.0.0', '< 6.0'
end
No topo do seu Podfile, certifique-se de ter platform :ios, '11.0'. - Ou uma versão mais recente do iOS se seu aplicativo exigir.
# Descomente esta linha para definir uma plataforma global para seu projeto
platform :ios, '11.0'
Abra o terminal, faça 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.
- Runner (true) and OneSignalNotificationServiceExtension (false) do not both set use_frameworks!.

Código do OneSignalNotificationServiceExtension

No navegador de projetos do Xcode, selecione a pasta OneSignalNotificationServiceExtension e abra o arquivo NotificationService.m ou NotificationService.swift. Substitua todo o conteúdo do arquivo pelo seguinte código.
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 {
            /* DEPURAÇÃO: Descomente as 2 linhas abaixo para verificar se esta extensão está em execução
                          Nota: esta extensão só é executada quando mutable-content está definido
                          Definir um anexo ou botões de ação adiciona isso automaticamente */
            // print("Running NotificationServiceExtension")
            // bestAttemptContent.body = "[Modified] " + bestAttemptContent.body

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

    override func serviceExtensionTimeWillExpire() {
        // Chamado pouco antes de a extensão ser terminada pelo sistema.
        // Use isso como uma oportunidade para entregar sua "melhor tentativa" de conteúdo modificado, caso contrário, a carga push original será usada.
        if let contentHandler = contentHandler, let bestAttemptContent =  bestAttemptContent {
            OneSignalExtension.serviceExtensionTimeWillExpireRequest(self.receivedRequest, with: self.bestAttemptContent)
            contentHandler(bestAttemptContent)
        }
    }
}

Exemplo do arquivo NotificationService.swift.


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.
If you are testing with an Android emulator, it should start with a cold boot.
  1. Go to Device Manager in Android Studio.
  2. Select your emulator device and click Edit.
  3. Go to Additional Settings or More.
  4. Set the Boot option to Cold Boot.
  5. Save changes and restart the emulator.

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

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