Docs

Reclaim SDK docs

Lightweight, route-based documentation to get event tracking live and visible in your dashboard.

SDK reference

new ReclaimClient(config)

Creates a client for authenticated event ingestion.

client.track(payload)

Sends a typed event with user context and optional metadata.

Initialize client

const client = new ReclaimClient({
  baseUrl: process.env.NEXT_PUBLIC_API_URL,
  projectId: "<project-id>",
  apiKey: process.env.RECLAIM_API_KEY,
});

Track a high-intent event

await client.track({
  projectId: "<project-id>",
  user: {
    externalId: "u_456",
    email: "owner@acme.com",
    name: "Taylor",
  },
  event: "started_checkout",
  properties: {
    plan: "starter",
    step: "billing",
  },
});

Use consistent user identity fields across events so Reclaim can stitch session activity and recovery outcomes correctly.

Integration checklist

Track at least one activation and one checkout-related event.
Verify intent logs appear under the active project.
Confirm templates include variables like {{name}} and {{projectName}}.
Run one end-to-end recovery send in manual mode before enabling auto mode.