Dashboard setup

What a developer sets up in the Bubbl dashboard before and after adding the SDK, and where each setting lives.

Everything a developer needs is under Configuration in the dashboard's sidebar. Owners, admins and developers see it. In the sidebar the pages read Developer Settings, Plugin Settings, Firebase Configuration and Apple Push; this documentation uses their page titles, such as Configuration › Developers. Developers, Firebase and Apple Push need a paid plan. On the Free plan they're greyed out, because the Free plan doesn't include your own app. See Plans and going live.

What you need, and where#

There's one workspace, Production. Everything you set up and create is live.

The SDK API key#

Open Configuration › Developers. The SDK API key card shows the workspace's key, masked. It starts pk_live_. Choose Reveal or Copy (the dashboard asks you to confirm it's you first). Under the key is the API address, https://api.bubbl.tech: pass it to start as baseUrl, exactly as shown, without /api/v1. A key only works at its own workspace's address; with the wrong pair the server answers wrong_environment and the SDK stops, logging which address to use.

The key only identifies your workspace, so it's safe to ship in your app. Rotate key issues a new one; you choose whether the old key stops registering new installs straight away or keeps doing so for 7 days while your new build rolls out. An install started with the new key registers again as a new device.

The same page has a Quick start with the install line and start call for each platform, SDK health (devices, last check-in and the SDK versions in use). More on the page: Developers.

Set up the SDK (guided)#

The Quick start on Configuration › Developers links to Set up the SDK, a guided page that walks through choosing a platform, getting your key, installing, initialising, permissions and a first call. See SDK setup. The Quickstart in these docs covers the same steps with the code.

Push credentials#

Android (Firebase). Bubbl sends Android pushes through your own Firebase project. Under Configuration › Push › Credentials, upload the project's service-account JSON and choose Validate and upload. Optionally, under Android apps, upload the project's google-services.json and choose Check and save: apps whose package name is in it then need no google-services.json of their own, because the SDK starts Firebase for them. More: Firebase.

iOS (Apple Push). Bubbl sends iOS pushes straight to Apple (APNs), without Firebase. Under Configuration › Push › Add an app, enter the Bundle ID, Key ID and Team ID, choose the APNs auth key (.p8) from developer.apple.com › Keys (with Apple Push Notifications enabled), and choose Check and save. Bubbl checks the key with Apple before saving it. Add each iOS app by its bundle ID; adding one that's already there replaces its key. More: Apple Push.

Neither page sends a test push. To check that pushes reach a phone, see Check that pushes arrive.

Privacy view#

Configuration › Plugin › Runtime › Privacy view decides when the SDK shows its privacy view before a permission prompt: Show automatically (the first time each kind of permission is asked for), Always show, or Never show. The Privacy text under Callbacks & privacy is the text it shows. See Permissions and privacy and Privacy.

After the SDK is in#

• Active users: the Active users card on the dashboard's home page opens a panel with the devices active in the workspace and their platform, SDK version and push mix. See Active users.
• Segments: the segments your app sets with setSegments appear under Company › Segments the first time a device reports one. See Segments and events and Segments.