Onboarding with FlareLane

FlareLane is an SDK designed by developers for developers. By adding just a single line of code to your app or website, you can start sending, operating, and analyzing push notifications.
Follow our guide below for an easy start with FlareLane.

1. SDK Setup

After signing up to FlareLane and creating a project, select a channel and install FlareLane SDK to your app or website.
After installation, devices (customer's app or web browser) that have subscribed to push notifications will automatically be added to your FlareLane project.
FlareLane offers two types of SDK setup options for Web Push: Direct push and Indirect push. For typical HTTPS websites, select Direct push. For websites without HTTPS, select Indirect push.
Mobile Push
Web Push
Direct Push (Typical HTTPS websites)
Indirect Push (Websites without HTTPS)

2. Integrate User ID and Tags

Integrating custom data to the devices can help you to further personalize and automate push messages. You can set User ID and Tags.

User ID

User ID is a unique identifier you have assigned to your app or website users.
Associate User ID with each corresponding device. A User ID can take the form of an email address, user ID, or random numbers, depending on the format you use to identify your app or website customers.
Using the User ID, you can target the devices by specific User ID or segment the customers into two groups: members and non-members.
Integrating User ID
Assign User ID when the user logs into the app or website.
  • Use this SDK method: FlareLane.setUserID("USER_ID")


Tags are a form of metadata that you can add to your customers, such as name, gender or VIP status. FlareLane allows Booleans, Numbers and Strings. Numbers must follow Unix Timestamp millisecond format (ex. 1681721331085)
Tags are essential for creating targeted Segments and personalizing messages.
For example, a male customer named Michael who made 2 purchase orders can be set as below.
"name": "Michael",
"gender": "male",
"age": 24,
"order_count": 2,
"firstPurchasedAt": 1681721331085
Integrating Tags
  • Use this SDK Method: FlareLane.setTags({ key: value }})
  • Use this API: PATCH /v1/projects/PROJECT_ID/users/tags

3. Install Send API

When using the FlareLane API to send push notifications from your server, use Templates to save time and reduce your workload. You can easily modify the message from the FlareLane console whenever needed.
Instead of using FlareLane's Pre-built Automations, you can choose to send push notifications from your server using the FlareLane API.
To do this, simply insert the template ID into your code, which you can find at Templates > select a template.
  • Use this API: POST /v1/projects/PROJECT_ID/notifications

4. Create Inbox

To prevent exposing the API key, avoid executing the API directly from the client.
Due to the nature of push notifications, they are typically not viewable again once closed. However, FlareLane provides an API that allows you to access device-specific notification history.
Just design the UI, and you can give your customers the ability to review past notifications they've received.
  • Use this API: GET /v1/projects/PROJECT_ID/devices/DEVICE_ID/notification-history

Automatically Manage Subscription Status

Push notifications may become un-receivable due to various situations, including app deletion, invalid tokens, and permission reset.
FlareLane offers a device management solution by automatically unsubscribing devices from push notifications in the following scenarios by setting isSubscribed=false:

Subscription status updates based on push notification results

FlareLane automatically unsubscribes a device based on the response received after sending push notifications.
The criteria for determining specific responses are based on the responses received from each sending server (FCM, APNS).
FCM (docs)
  • InvalidRegistration
  • NotRegistered
APNS (docs)
  • BadDeviceToken
  • Unregistered (Deleted apps may take several days to be reflected in accordance with Apple's policy)