Docs
kirora.ioJoin the waitlist
Menu

Getting started

Set up push

Configure web, iOS and Android push apps and connect device registration with your developer.

Set up push to reach people in your iOS app, Android app or website. An admin adds the apps and credentials in Kirora, then a developer connects device registration and notification handling. Kirora sends through Apple, Firebase and browser push services.

How push apps are organised

  • A push app is your product on one platform: Web, iOS or Android.
  • A push project groups the apps for the same product, for example Juniper Kitchen web, Juniper Kitchen iOS and Juniper Kitchen Android. A project has at most one app per platform.

Campaigns and journeys send to a project. Each contact gets the notification on every device they’ve registered across that project’s ready apps.

Add your first app

Only an admin or the owner can add push apps.

  1. Open Settings, then Push apps.
  2. Choose Add app.
  3. Enter a Name you’ll recognise, such as Juniper Kitchen web.
  4. Choose the Platform.
  5. Choose the Environment. Use Production for your live website and for apps in the App Store or Play Store. Use Sandbox only for development builds.
  6. Choose Add app.

This creates the app and a project for it. To add another platform to the same project, choose Add app on that project’s card. The new app shares the project’s environment.

Finish each platform’s setup

Web. A web app is ready to send as soon as it’s added. Its page shows a Public key (VAPID) and a Service worker snippet. Your developer adds these to your website.

iOS. On the app’s page, choose Upload key and pick how it sends:

  • Apple (APNs key): upload the .p8 key file from your Apple developer account, and enter its Key ID, Team ID and your app’s Bundle ID. One key works for both sandbox and production, so you can upload the same key to both apps.
  • Firebase: if your iOS app already registers with Firebase, upload a Firebase service account file instead.

Android. Choose Upload key and upload a Firebase Service account JSON file. In Firebase, it’s under Project settings › Service accounts › Generate new private key.

Kirora checks the key with Apple or Google before saving it, stores it encrypted and never shows it again. To swap a key, choose Replace.

The Push apps page shows each app as Ready to send or Not ready yet, its next step, and how many devices are registered.

What your developer needs to do

Kirora never creates device registrations itself. Your developer needs to:

  1. Ask people for notification permission in your app or website.
  2. Register each device or browser against the right contact, from your own server, using an API key. Apps should register every time they start, because a device that isn’t seen for 60 days stops receiving pushes.
  3. Report when someone revokes permission or signs out.
  4. Report opens and clicks back to Kirora from your app or service worker, so they appear in your reports.

On the app’s page, Copy App ID gives your developer the app’s identifier. Point them to the API quickstart and the API reference.

Allowing notifications on a phone or in a browser isn’t the same as agreeing to marketing. A contact also needs push consent in Kirora before they can receive campaign and journey pushes. You can record it when you import contacts, on a contact’s profile, or through the API. See Consent and unsubscribes.

Send yourself a test

Once your own device is registered against a contact with your email address, open a campaign’s Push notification step and choose Send to my device. The test goes only to your devices and isn’t recorded in reports. See Test and preview a campaign.

Remove an app or project

Use the menu on an app or project to rename or delete it. Deleting an app also removes its registered devices. You can’t delete a project while a scheduled campaign or a live or paused journey sends to it.