// getting started
Getting Started
From zero to your first event in about five minutes. No config files, no dashboards to babysit.
1 /
Create a project
Log in to the dashboard and create a project. You'll get an API key that looks like cl_xxx — this key authenticates your SDK calls.
2 /
Install the SDK
terminal
npm install @customerlog/sdk
route.ts
import { CustomerLog } from "@customerlog/sdk";
const customer = new CustomerLog({
apiKey: "cl_xxx",
});
3 /
Log your first event
stripe-webhook.ts
await customer.log({
channel: "payments",
title: "Payment succeeded",
message: "Annual plan, card charged",
metadata: { email: "jane@doe.com", plan: "pro", amount: 299 },
notify: true,
});
// → delivered to your Slack + live feed instantly
4 /
See it show up
Open your dashboard and the event is there in the live feed, filterable by channel. If you configured a Slack webhook or email recipients, it lands there in real time too.
That's it. Call customer.log() anywhere in your code — signups, payments, plan limits, errors, custom events — and stop refreshing Stripe to find out what happened.
5 /
Next steps
- Implement it in your framework — see SDK Implementations.
- Structure events well for AI summaries — see Event Types.
- Get notified in Slack and email — see Integrations.
- Full options for the log call — see SDK Reference.