Quickstart

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 Account API keys in browser code, mobile apps, or public repositories.

Set up your account

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

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.

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 an Account 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.

Create an Account API key

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

Choose permissions

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

Copy the key

Copy the key when Whop shows it. Store it in your local .env file as WHOP_API_KEY.

Whop dashboard Account API Keys section showing a key name, masked value, and Create button

Install the SDK

pnpm add @whop/sdk

pip install whop-sdk

gem install whop_sdk

Add your credentials to .env:

WHOP_API_KEY=whop_xxxxxxxxxxxxxxxxx

Make your first call

Retrieve the Account tied to your API key. This confirms your key and permissions are wired correctly and prints your Account ID, which starts with biz_.

import Whop from "@whop/sdk";

const apiKey = process.env.WHOP_API_KEY;

if (!apiKey) {
  throw new Error("Set WHOP_API_KEY");
}

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

const account = await client.accounts.me();

console.log(account.id);

import os
from whop_sdk import Whop

client = Whop(
    api_key=os.environ["WHOP_API_KEY"],
)

account = client.accounts.me()

print(account.id)

require "whop_sdk"

whop = WhopSDK::Client.new(
  api_key: ENV.fetch("WHOP_API_KEY"),
)

account = whop.accounts.me

puts account.id

See a webhook

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

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.

Create the webhook in the dashboard

Open Developer > Webhooks, then click Create webhook.

Whop Developer Webhooks page with a Create webhook button

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

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.

Introduction

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats

Set up your account

Create an API key

Install the SDK

Make your first call

See a webhook

Next steps

Accept payments

Validate webhooks

API walkthrough

​Set up your account

​Create an API key

​Install the SDK

​Make your first call

​See a webhook

​Next steps

Accept payments

Validate webhooks

API walkthrough

Set up your account

Create an API key

Install the SDK

Make your first call

See a webhook

Next steps