Getting Started - Confidence Documentation

Before You Begin

You need:

A Confidence account with Recordings enabled
A browser client secret for the environment you want to record
Permission to create or edit a recording policy
A recording policy with an active rule for your client

To create a policy, you need the Account Owner, Admin, Super Admin, Creator, or Recording Policy Creator role. An Editor or Recording Policy Editor can edit an existing policy but cannot create one.

Set Up the SDK

Install the package

npm install @spotify-confidence/session-recording

Review the privacy controls

The SDK masks input values by default. Review privacy and data masking before you enable recording in a production environment.

Initialize the recorder

import { initSessionRecorder } from '@spotify-confidence/session-recording';

const recorder = initSessionRecorder({
  clientSecret: '<your-client-secret>',
  appVersion: '2.3.1',
  context: {
    plan: 'premium',
    checkout_version: 'one-page',
  },
});

appVersion stores an application version or commit hash on the recording. Confidence uses context to evaluate recording rules before capture starts. Do not add direct personal identifiers, access tokens, or secrets to context.The SDK uses automatic mode by default. It starts capture when the session matches an active recording rule.

Verify recording

Interact with the application and check recorder.isRecording. It becomes true after capture starts.A false value does not always indicate an error. A rule, sample rate, or account capacity can exclude the session.

Finish the test session

Close the test tab. If other tabs share the browser session, close those tabs too. Each tab appears as a separate recording. Allow several minutes after the browser session ends before you check Recordings.

Add Debug Logs

Pass a logger while you set up the SDK:

const recorder = initSessionRecorder({
  clientSecret: '<your-client-secret>',
  debugLogger: message => console.debug(message),
});

The logger reports when recording starts, when Confidence skips the session, connection changes, and worker errors. The SDK returns a recorder and does not throw setup errors to the application.

Customize Recordings

Configure privacy

Mask or block sensitive content before it leaves the browser.

Configure recording rules

Control which users and sessions the SDK records.

Add custom data

Add context, tags, and measurements.

Parameterize routes

Group dynamic application routes.

Integrate feature flags

Keep recording and feature flag targeting context consistent.

Explore recordings

Learn what you can review in the Confidence UI.

SDK reference

Review all SDK options and methods.

Troubleshoot recordings

Diagnose SDK setup and capture problems.

​Before You Begin

​Set Up the SDK

​Add Debug Logs

​Customize Recordings