Onboarding with FlareLane

FlareLane is 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 mobile or web browser) that have subscribed to push notifications will automatically be added to your FlareLane project.
Mobile Push
Web Push
Web Push

2. Integrate User ID, Events 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.
How to use:
Assign User ID when the user logs into the app or website.


Events are actions a user performs in the app or website, such as sign-up and purchase.
Events allow you to trigger push notifications based on the user's actions. Some common use cases include:
  • Sending a reminder push notification 3 days after a user adds a product to the cart
  • Sending a push notification to write a review 1 day after a user makes a purchase
If you have integrated the User ID, the event will trigger on all devices associated with that User ID. If the User ID is not integrated, the event will trigger on each individual device.
How to use:


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
How to use:

3. Integrate Send API

you can send push notifications from your server using API.
How to use:
  • REST API: POST /v1/projects/PROJECT_ID/notifications

4. Integrate Notification Center API

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 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.
How to use:
  • REST 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.
For convenience, FlareLane automatically unsubscribes(isSubscribed=false) a device that is not valid.