Install the web SDK

Turn on Flamio On-Live for a project, add the web SDK to your site, and check that the first visits arrive.

Add the Flamio web SDK to your site to start recording real visitors. You need one project key and two pieces of code, both shown on the Setup page.

Recording starts on page load

By default, the SDK records every visitor from the moment it loads. If your site must ask for consent first, set that up before you deploy. See Record only after consent.

Before you begin

You need the Editor, Admin or Owner role. Viewers can open Setup, but they do not see Enable Flamio On-Live or Generate API key. See Team and roles.
Select the project in the sidebar project switcher. The project must cover a website. If it covers only a mobile app, step 3 shows the mobile install instead — see Record your mobile app.
You need access to your site's code and a way to deploy it. Flamio cannot add the snippet for you.

Open the Setup page

In the sidebar, under Flamio On-Live, click Setup.

If the page reads Select a project to get started, pick a project in the sidebar project switcher first.

Turn On-Live on

Click Enable Flamio On-Live.

The page becomes a four-step checklist. Step 1 is ticked as Flamio On-Live enabled.

Generate the project key

In step 2, click Generate API key, then click Copy.

The page warns Save this key now. It will not be shown again. Keep the key with your other project secrets. On later visits, step 2 reads API key generated, and the page does not show your key again. If you lose it, revoke it and generate a new one — see Stop recording.

Install the package

In step 3, Install the SDK, copy the install command and run it in your site's project:

npm install @flamioai/web-sdk

Add the snippet to your site

Copy the JavaScript block under the install command. Right after you generate the key, the Setup page fills it into this block.

import { Flamio } from '@flamioai/web-sdk';

Flamio.init({
  projectKey: 'YOUR_KEY_HERE',
  endpoint: 'https://api.flamio.org/api'
});

YOUR_KEY_HERE — your project key from step 2 of the Setup page. Leave endpoint exactly as it is.

Paste the snippet into your site's entry point, so that it runs once, as early as possible, on every page. Route changes in a single-page app are recorded on their own. For framework-specific placement, see Single-page apps.

To compare releases later, also pass your release version. See Check the impact of a release.

Deploy your site

Deploy the change, so that the snippet runs in the build your visitors load.

Wait for the first visit

Step 4 reads Waiting for first data….

To test it yourself, open your deployed site and click around for a minute. Then reload Setup: once the first session arrives, step 4 changes to Data is flowing and counts the sessions recorded.

Result

Click Go to Overview in step 4. The Overview shows your first numbers, and Visits lists each recorded visit as a replay. See Read the Overview.

If step 4 keeps waiting, see Troubleshooting.

Choose which domains can send sessions

By default, any domain that runs your snippet can send sessions to the project. To accept sessions only from your own sites:

Click Settings > Project settings. The Flamio On-Live section reads Which domains and apps may record sessions for this project, and how to stop capture.
Under Allowed domains (Only these domains can send sessions. Leave empty to allow any.), enter one domain per line, for example app.example.com. Use *.example.com to match every subdomain.
If the card offers + Add example.com (this project’s site) with your own site's host, click it to add that host.
Click Save.

List every host where the SDK runs, including staging and subdomains. A host that is not on a non-empty list cannot send sessions. You need the Editor, Admin or Owner role to change the list. See Project settings.

Stop recording

Both actions are under Settings > Project settings > Danger zone. Recordings you already have are kept.

Revoke API key — sites using the key stop sending sessions immediately. To record again, generate a new key on Setup and update the snippet on your site. Confirm with Revoke key.
Disable Flamio On-Live — recording stops for the whole project until you enable it again on Setup. Confirm with Disable.

To stop recording on some pages only, use page rules instead. See Mask sensitive content.

Web SDK configuration — every Flamio.init option and its default
Identify your visitors
Mask sensitive content
Record only after consent
Troubleshooting

Install the web SDK

On this page