Skip to content

Quickstart: record to rrweb Cloud ​

Install the rrweb Cloud browser client and send your first recording in a few minutes.

1. Create an API key ​

Create a public API key in the rrweb Cloud dashboard. Public keys can create recordings from browser code but cannot read your account data.

2. Install the browser client ​

bash
npm install @rrweb/browser-client

3. Configure privacy before capture ​

Start on a non-sensitive test page with synthetic data. Mark any subtree that must not be captured with data-private, mark text that may contain sensitive values with data-mask, and mask every input value for this first run. Blocking omits a matching subtree and replaces it with a placeholder; masking preserves enough structure for replay while replacing its text or input value. See Recording and privacy settings before expanding capture beyond a test page.

4. Start recording ​

Call start() once when your application loads:

javascript
import { start } from '@rrweb/browser-client';

start({
  publicApiKey: 'your-public-api-key',
  blockSelector: '[data-private]',
  maskTextSelector: '[data-mask]',
  maskAllInputs: true,
});

The client records browser events, streams them to rrweb Cloud over WebSocket, and falls back to HTTP when the connection is interrupted.

5. Replay the recording ​

Open Recordings in the dashboard and select the new recording. It may take a few seconds to appear.

Next steps ​