Quickstart

Recording takes three steps on every platform: install, initialize, verify.

Grab your project key from the dashboard: app.replayfy.app → Settings → Install → API keys. It looks like rpl_pk_… and is safe to ship in your app — it’s a publishable key, not a secret. Replace rpl_pk_YOUR_KEY below with yours.

Web
iOS
Android
React Native
Flutter

Install

npm install @replayfyapp/browser

<!-- Async, non-blocking loader — queues init/track calls until ready. -->
<script>
  !(function () {
    var r = (window.Replayfy = window.Replayfy || []);
    ['init', 'identify', 'track', 'captureException', 'flush', 'stop'].forEach(function (m) {
      r[m] = function () { r.push([m].concat([].slice.call(arguments))); };
    });
    var s = document.createElement('script');
    s.async = true;
    s.crossOrigin = 'anonymous';
    s.src = 'https://cdn.replayfy.app/v1/replay.global.js';
    var f = document.getElementsByTagName('script')[0];
    f.parentNode.insertBefore(s, f);
  })();
</script>

Initialize

Use the tab that matches how you installed.

import { initReplay } from "@replayfyapp/browser";

initReplay({
  apiKey: "rpl_pk_YOUR_KEY",
  apiHost: "https://us.replayfy.app",  // or your self-hosted API URL
});

<script>
  Replayfy.init({
    apiKey: "rpl_pk_YOUR_KEY",
    apiHost: "https://us.replayfy.app",  // or your self-hosted API URL
  });
</script>

Verify

Reload your site, click around, then open Recordings in the dashboard — your session appears within seconds.

Install

pod 'Replayfy', '~> 0.0.4'

// File → Add Packages… → https://github.com/replayfy/ios-sdk  (from: 0.0.4)

Initialize

Start recording from your App / AppDelegate:

import Replay

Replay.start(with: ReplayConfig(
    apiKey: "rpl_pk_YOUR_KEY",
    apiHost: "https://us.replayfy.app"  // or your self-hosted API URL
))

Verify

Run the app, tap around, then open Recordings in the dashboard.

Install

Add the dependency — it resolves from Maven Central, so no extra repository is needed (mavenCentral() is already in the default Android template):

// app/build.gradle.kts
implementation("app.replayfy:android-sdk:0.0.4")

Initialize

Start recording from Application.onCreate:

import com.replayfy.android.Replay
import com.replayfy.android.ReplayConfig

Replay.init(
    this,
    ReplayConfig(
        apiKey = "rpl_pk_YOUR_KEY",
        apiHost = "https://us.replayfy.app",  // or your self-hosted API URL
    ),
)

Verify

Launch the app, tap around, then open Recordings in the dashboard.

Install

npm install @replayfyapp/react-native
cd ios && pod install && cd ..

Initialize

Call once, as early as possible (e.g. App.tsx):

import Replay from '@replayfyapp/react-native';

Replay.start({
  apiKey: 'rpl_pk_YOUR_KEY',
  apiHost: 'https://us.replayfy.app',  // or your self-hosted API URL
});

Verify

Rebuild the app, tap around, then open Recordings in the dashboard.

Install

flutter pub add replayfy_flutter

Initialize

Start recording in main, before runApp:

import 'package:replayfy_flutter/replayfy_flutter.dart';

await Replay.start(const ReplayConfig(
  apiKey: 'rpl_pk_YOUR_KEY',
  apiHost: 'https://us.replayfy.app',  // or your self-hosted API URL
));

Verify

Run the app, tap around, then open Recordings in the dashboard.

That’s it

You’re recording. Next, make the data yours:

Identify users

Track events

Privacy & masking

Need the full API and config for your platform? See the per-SDK pages under SDKs.

Get started

Self-hosting

Install the SDK

Products

Platform

Guides

Help

That’s it

Identify users

Track events

Privacy & masking

​That’s it

Identify users

Track events

Privacy & masking

That’s it