Quickstart

Create a project, get your API key, and collect your first subscriber in under five minutes.

This guide walks through the fastest path from zero to your first subscriber.

1. Create a project

Sign in to waitkit.dev and create a new project. Give it a name and a unique slug — the slug identifies your waitlist in API calls.

Once created, you land on the project overview page.

2. Generate an API key

Navigate to the API Keys tab for your project and create a new key. Copy the key immediately — it is shown only once.

The key starts with wk_ and is used to authenticate API requests.

3. Install the SDK

npm install waitkit

4. Configure and call

This call must run in the browser, not on a server. Calling create() from a server route will skew your analytics. See Integration Guide.

import { WaitKit } from "waitkit";

const wk = new WaitKit({
  apiKey: "wk_...",
  projectSlug: "my-project",
});

await wk.subscribers.create({ email: "user@example.com" });

5. Verify in the dashboard

Open your project's Waitlist tab. The subscriber appears in the entries table.

That is it. For a deeper look at the SDK, see the JavaScript SDK reference. To integrate without the SDK, see the REST API.