Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.whop.com/llms.txt

Use this file to discover all available pages before exploring further.

Use this page the first time you connect Whop to your app or backend. You’ll sign up, open the dashboard, create an API key, install the SDK, make your first call, and watch a webhook land on your server.
Keep WHOP_API_KEY on your server. Do not put Company API keys in browser code, mobile apps, or public repositories.

​
Set up your account

1

Sign up for Whop

Go to whop.com/new and create your Whop account. The onboarding flow creates your first business, which is the company that owns API keys, products, webhooks, and payments.
2

Open the dashboard

After onboarding, open whop.com/dashboard. If you have more than one business, choose the one you want to build against from the business switcher.
3

Open Developer

Click Dashboard ↗ in the top-right corner of these docs to open your developer dashboard directly.

​
Create an API key

For the quickest path, create a Company API key. Use this when your server acts on behalf of your own business. Building a Whop App? Learn when to use App API keys and OAuth tokens.
1

Create a Company API key

In Company API Keys, click Create. Name the key something you can recognize later, like Local development or Production payments.
2

Choose permissions

For the first SDK call below, use the Admin role or grant the read permissions listed on List payments. For production, switch to a narrower custom permission set once you know exactly which endpoints you use.
3

Copy the key

Copy the key when Whop shows it. Store it in your local .env file as WHOP_API_KEY.
Whop dashboard Company API Keys section showing a key name, masked value, and Create button
4

Save your company ID

Your company ID starts with biz_. You can find it in the dashboard URL when viewing your business.
Whop dashboard URL showing a company ID that starts with biz_

​
Install the SDK

pnpm add @whop/sdk
Add your credentials to .env: 
WHOP_API_KEY=whop_xxxxxxxxxxxxxxxxx
WHOP_COMPANY_ID=biz_xxxxxxxxxxxxx

​
Make your first call

List recent payments for your company. If your account is new, the response may be an empty list; that still confirms your key, permissions, and company ID are wired correctly. 
import Whop from "@whop/sdk";

const apiKey = process.env.WHOP_API_KEY;
const companyId = process.env.WHOP_COMPANY_ID;

if (!apiKey || !companyId) {
  throw new Error("Set WHOP_API_KEY and WHOP_COMPANY_ID");
}

const client = new Whop({
  apiKey,
});

const page = await client.payments.list({
  company_id: companyId,
  first: 5,
});

console.log(page.data.map((payment) => payment.id));

​
See a webhook

Whop sends a webhook to your server when something happens in your business, like payment.succeeded or membership.activated.
1

Create a local webhook endpoint

Add a POST endpoint in your app and expose it with ngrok, Cloudflare Tunnel, or another HTTPS tunnel while developing.
2

Create the webhook in the dashboard

Open Developer > Webhooks, then click Create webhook.
Whop Developer Webhooks page with a Create webhook button
3

Enter your URL and events

Paste your HTTPS endpoint, keep the API version on v1, and select the events you want to receive.
Create webhook form showing the endpoint URL and API version fields
Create webhook form showing payment_succeeded selected in the events list
4

Send a test event

Use the webhook row actions to send a test event. When your server logs the request, your setup is complete.
Whop dashboard test webhook menu showing Send event

​
Next steps

Accept payments

Create checkout links or embedded checkout flows.

Validate webhooks

Verify signatures and handle payment events safely.

API walkthrough

Explore endpoints, SDK examples, and required permissions.