ChangelogEdit pageSTAFFOpen dashboard
ConfigurationSet up the SDK

Set up the SDK

A guided setup that takes your app from choosing a platform to a test device passing six live checks, and then unlocks the Production key.

Go to Configuration › Developers and click Set up the SDK. The page is for owners, admins and developers, and remembers where you got to. SDK docs at the top of the page opens the SDK docs in a new tab.

  1. 1
    Choose platform
    Pick iOS (Swift, iOS 13+), Android (Kotlin, API 23+), React Native (RN 0.76+) or Flutter (Flutter 3.32+). Every snippet after this is tailored to it.
  2. 2
    Get your SDK key
    Under App details, enter the App name and your app's ID (Bundle ID on iOS, Application ID on Android), then click Generate key. The Sandbox key is scoped to that app ID and filled into every snippet that follows.
  3. 3
    Install the SDK
    Choose your package manager and add the Bubbl package to your project with the snippet shown.
  4. 4
    Initialise
    Call start once, as early as possible when your app launches. Your Sandbox key and address are already in the snippet.
  5. 5
    Permissions
    Add the entries the snippet shows and tick each one: Location · Always and Notifications are required, Background refresh is optional.
  6. 6
    First call
    Click Start listening and run your app on a real device; simulators can't test geofences reliably. The page shows First call received when your app talks to Bubbl.
  7. 7
    Test checklist
    Run the six checks below on the device and watch Live events. When all pass, Your SDK is set up and you can Create first campaign.

The six checks#

CheckHow it passes
Device registeredThe app called start and registered this device.
Location permission: AlwaysThe device granted background location, so geofences trigger while the app is in the background.
Push token receivedThe APNs or FCM token synced to Bubbl.
Receive a test pushClick Send test push; the device gets "Bubbl test push".
Trigger a test geofenceClick Create test geofence; a temporary 100 m geofence is placed at the device's location.
Geofence notification shownThe device shows the notification when it enters the test geofence.

The Connection panel beside the steps shows whether a device is connected, and Live events lists requests from your app as they arrive.

The Production key#

On the key step, switch to Production. It stays locked until every check has passed on the Sandbox key. Then click Reveal production key and confirm it's you. Use it with the Production address in your release build, and keep the Sandbox key for development.

Receive a test push needs push credentialsUpload your Firebase service account for Android, or your Apple Push key for iOS, before the test push check.

For the code behind each step, see the SDK quickstart, Permissions and privacy, Push notifications and Testing and diagnostics.