Getting started

This page is the shortest path from zero to working analytics in your extension.

What you need

• A Manifest V3 extension (Chromium or Firefox 109+).
• A Moderok app key that looks like mk_ followed by at least 16 letters or numbers.
• The storage permission (Manifest & permissions).

Steps

1. Install the package (Install covers npm and standalone builds).

npm install @moderok/sdk

2. Allow storage in manifest.json (Manifest & permissions).

{
  "permissions": ["storage"]
}

storage does not add a permission prompt on install.

3. Initialize in the background service worker at the top level, before any await (Initialization).

// If you're not using a bundler: import { Moderok } from "./moderok.min.js";
import { Moderok } from "@moderok/sdk";

Moderok.init({ appKey: "mk_your_app_key_here" });

4. Track events from popups, options, content scripts, or anywhere else (Events & properties).

import { Moderok } from "@moderok/sdk";

Moderok.track("settings_saved", { theme: "dark" });

That is enough for lifecycle events, daily activity, and automatic error capture. Optional topics: Error tracking, Uninstall tracking, Patterns for background-only tracking.

If you use WXT, follow WXT instead — it uses a different integration path.

Where data shows up

Open the Moderok dashboard to see installs, events, and errors after users run your extension.