SDK Overview

The Bubbl SDK lets your app receive location-aware campaigns, push notifications, media, calls to action, and surveys that you configure in Bubbl.

Use this guide when you are adding Bubbl to a mobile app for the first time or upgrading an existing integration to SDK 4.0.2.

Supported platforms

How integration works

1. Get your Bubbl API key from the Bubbl dashboard.
2. Add the SDK package for your platform.
3. Boot the SDK with your live Bubbl API key.
4. Ask the user for notification and location permissions at the moment your app needs them.
5. Configure Firebase Cloud Messaging for push notifications.
6. Forward push tokens, notification payloads, and location updates to the SDK when your app receives them.
7. Test diagnostics, campaign config, push handling, geofence handling, and survey paths before release.

Live environment

Use the live Bubbl environment for your integration.

You normally do not need to set custom endpoints. Only set endpoint URLs when Bubbl support asks you to do so.

Common implementation patterns

Bubbl is usually added to an existing product journey rather than treated as a separate screen. These patterns map the SDK features to common app experiences:

• Retail or venue apps: request location permission when the user enables nearby offers, then use geofences and push notifications to show eligible venue campaigns.
• Transport or customer assistance apps: forward app-managed location updates when a user starts a journey, then show service messages, wayfinding CTAs, or feedback surveys.
• Field operations apps: use segment tags such as role, region, or route to control campaign eligibility, and use a correlation ID to connect Bubbl events to your own job or visit reference.
• Loyalty apps: update segments after sign-in or tier changes so campaigns can target members without exposing private customer details to the SDK.
• Feedback flows: use Bubbl surveys after a notification, visit, pickup, or support interaction, then test both CTA and no-CTA campaign variants.
• Analytics and event correlation: set a correlation ID and call track for supported app milestones so Bubbl activity can be matched to your product funnel.

What the SDK can handle for you

The SDK can:

• Fetch campaign configuration for your API key.
• Register the device and push token.
• Read and evaluate geofence campaigns.
• Show Bubbl's default notification modal and survey UI.
• Track notification interactions, media views, CTA taps, survey answers, and location events.
• Queue events locally while offline and send them when the device can connect again.
• Provide diagnostics that help you confirm the integration is healthy.

What your app still owns

Your app owns:

• User consent and permission timing.
• Firebase project setup and platform config files.
• APNs capabilities and provisioning for iOS.
• App Store and Play Store privacy disclosures.
• Any host-rendered notification UI if you choose not to use the default Bubbl UI.