Web SDK

With the FlareLane Web SDK, you can run CRM marketing campaigns targeting website users, including through the Web Push channel. This guide walks you through installing the SDK on a website you operate yourself, such as your own online store.

In the FlareLane console, go to [Channels] > [Web Push] to begin entering your basic information.

Download the sw.js file below and upload it to the root path of your website. (For example, for a sw.js file on the example.com domain, it must be accessible at example.com/sw.js.)

If uploaded correctly, the file and its code can be accessed externally, like this:

https://gp.flarelane.com/sw.js

Add the following script just above your website's </body> tag. You can find your project ID on the [Projects] page in the console.

<script src="https://cdn.flarelane.com/WebSDK.js" charset="UTF-8"></script>
<script>FlareLane.initialize({ projectId: "PROJECT_ID" });</script>

When a user subscribes to Web Push, the device created in FlareLane is an "anonymous device." By integrating the unique user ID that you manage on your side, you can match FlareLane devices to your own user IDs.

Integrating user IDs offers many benefits. It lets you distinguish between members and non-members, and you can send push notifications by user ID at any time, so we recommend setting this up during your initial integration.

Typically, you integrate the user ID via the setUserId function when a user successfully signs up or logs in.

FlareLane.setUserId("USER_ID");

Once the integration is complete, users will see a subscription prompt when they visit your website. (The language depends on the browser language.)

When a user clicks Allow, they are automatically subscribed to notifications and can continue to receive notifications even after leaving the browser.

• Following the In-App Messages (Popups) guide, add a single line of code (displayInApp) at the point where you want the popup to appear.

• Set up the customer data integration needed for hyper-personalized push marketing, such as customer journey campaigns and personalized messages (Liquid).

• Use the setNotificationConvertedHandler function in the Web SDK Reference.