GitHub Repository
完整的源代码与设置指南
快速设置
1. 前置条件
你需要:2. 安装依赖
npm install -g vercel
vercel login
git clone https://github.com/dodopayments/cloud-functions.git
cd cloud-functions/vercel
npm install
3. 数据库设置
- 注册 Neon 并创建一个项目。
- 打开 SQL Editor。
- 复制
schema.sql的全部内容并运行。 - 从 Connection Details 中复制你的连接字符串。
4. 设置初始环境变量
vercel env add DATABASE_URL
vercel env add DODO_PAYMENTS_API_KEY
部署后,在获得 webhook URL 后,你将设置
DODO_PAYMENTS_WEBHOOK_KEY。5. 部署
npm run deploy
6. 获取您的 Webhook URL
您的 Webhook URL 是:https://[your-project].vercel.app/api/webhook
7. 在 DodoPayments 仪表板中注册 Webhook
- 前往 Dodo Payments 控制台中的 Developer → Webhooks。
- 点击 Add endpoint。
- 输入你的 webhook URL。
- 选择以下事件:
subscription.active、subscription.cancelled、subscription.renewed。 - 点击 Create endpoint 并复制 signing secret。
8. 设置 Webhook 密钥并重新部署
vercel env add DODO_PAYMENTS_WEBHOOK_KEY
npm run deploy
它的功能
webhook handler 会处理订阅事件并将其存储在 PostgreSQL 中:subscription.active— 创建或更新客户和订阅记录subscription.cancelled— 将订阅标记为已取消subscription.renewed— 更新下一次计费日期
主要特性
- 签名验证 — 使用 Dodo Payments SDK 验证 webhook 的真实性
- 幂等性 — 使用
webhook-idheader 防止重复处理 - 事件日志记录 — 将所有事件存储在
webhook_events表中,以便进行审计追踪 - 错误处理 — 记录失败并标记事件以便重试
此示例使用最少的字段处理三种核心订阅事件。你可以根据需要扩展它,以支持其他事件类型和字段。
配置文件
{
"name": "dodo-webhook-vercel",
"version": "1.0.0",
"type": "module",
"description": "DodoPayments Webhook Handler for Vercel",
"scripts": {
"start": "vercel dev",
"deploy": "vercel --prod"
},
"dependencies": {
"@neondatabase/serverless": "^1.0.2",
"dodopayments": "^2.4.1"
},
"devDependencies": {
"typescript": "^5.9.3",
"vercel": "^48.4.1"
}
}
{
"compilerOptions": {
"target": "ES2022",
"module": "ES2022",
"lib": ["ES2022"],
"moduleResolution": "node",
"esModuleInterop": true,
"strict": true,
"skipLibCheck": true,
"resolveJsonModule": true,
"allowSyntheticDefaultImports": true,
"forceConsistentCasingInFileNames": true,
"isolatedModules": true,
"types": ["node"]
},
"include": ["api/**/*.ts"],
"exclude": ["node_modules"]
}
数据库架构
-- DodoPayments Webhook Database Schema
-- Compatible with PostgreSQL (Supabase, Neon, etc.)
-- Enable UUID extension (if not already enabled)
CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
-- Customers table
CREATE TABLE IF NOT EXISTS customers (
id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
email TEXT NOT NULL,
name TEXT NOT NULL,
dodo_customer_id TEXT UNIQUE NOT NULL,
created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW()
);
-- Subscriptions table
CREATE TABLE IF NOT EXISTS subscriptions (
id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
customer_id UUID NOT NULL REFERENCES customers(id) ON DELETE CASCADE,
dodo_subscription_id TEXT UNIQUE NOT NULL,
product_id TEXT NOT NULL,
status TEXT NOT NULL CHECK (status IN ('pending', 'active', 'on_hold', 'past_due', 'paused', 'cancelled', 'failed', 'expired')),
billing_interval TEXT NOT NULL CHECK (billing_interval IN ('day', 'week', 'month', 'year')),
amount INTEGER NOT NULL,
currency TEXT NOT NULL,
next_billing_date TIMESTAMP WITH TIME ZONE NOT NULL,
cancelled_at TIMESTAMP WITH TIME ZONE,
created_at TIMESTAMP WITH TIME ZONE NOT NULL,
updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW()
);
-- Webhook events log
CREATE TABLE IF NOT EXISTS webhook_events (
id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
webhook_id TEXT UNIQUE,
event_type TEXT NOT NULL,
data JSONB NOT NULL,
processed BOOLEAN DEFAULT FALSE,
error_message TEXT,
created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
processed_at TIMESTAMP WITH TIME ZONE,
attempts INTEGER DEFAULT 0
);
-- Indexes for better query performance
CREATE INDEX IF NOT EXISTS idx_customers_email ON customers(email);
CREATE INDEX IF NOT EXISTS idx_customers_dodo_id ON customers(dodo_customer_id);
CREATE INDEX IF NOT EXISTS idx_subscriptions_dodo_id ON subscriptions(dodo_subscription_id);
CREATE INDEX IF NOT EXISTS idx_subscriptions_customer_id ON subscriptions(customer_id);
CREATE INDEX IF NOT EXISTS idx_subscriptions_status ON subscriptions(status);
CREATE INDEX IF NOT EXISTS idx_webhook_events_processed ON webhook_events(processed, created_at);
CREATE INDEX IF NOT EXISTS idx_webhook_events_type ON webhook_events(event_type);
CREATE INDEX IF NOT EXISTS idx_webhook_events_created_at ON webhook_events(created_at DESC);
CREATE INDEX IF NOT EXISTS idx_webhook_events_webhook_id ON webhook_events(webhook_id);
-- Function to automatically update updated_at timestamp
CREATE OR REPLACE FUNCTION update_updated_at_column()
RETURNS TRIGGER AS $$
BEGIN
NEW.updated_at = NOW();
RETURN NEW;
END;
$$ LANGUAGE plpgsql;
-- Triggers to automatically update updated_at
CREATE TRIGGER update_customers_updated_at
BEFORE UPDATE ON customers
FOR EACH ROW
EXECUTE FUNCTION update_updated_at_column();
CREATE TRIGGER update_subscriptions_updated_at
BEFORE UPDATE ON subscriptions
FOR EACH ROW
EXECUTE FUNCTION update_updated_at_column();
-- Comments for documentation
COMMENT ON TABLE customers IS 'Stores customer information from DodoPayments';
COMMENT ON TABLE subscriptions IS 'Stores subscription data from DodoPayments';
COMMENT ON TABLE webhook_events IS 'Logs all incoming webhook events for audit and retry purposes';
COMMENT ON COLUMN customers.dodo_customer_id IS 'Unique customer ID from DodoPayments';
COMMENT ON COLUMN subscriptions.dodo_subscription_id IS 'Unique subscription ID from DodoPayments';
COMMENT ON COLUMN subscriptions.amount IS 'Amount in smallest currency unit (e.g., cents)';
COMMENT ON COLUMN subscriptions.currency IS 'Currency used for the subscription payments (e.g., USD, EUR, INR)';
COMMENT ON COLUMN webhook_events.attempts IS 'Number of processing attempts for failed webhooks';
COMMENT ON COLUMN webhook_events.data IS 'Full webhook payload as JSON';
customers— 电子邮件、姓名和 Dodo Payments customer IDsubscriptions— 状态、金额、下一次计费日期,以及关联的客户webhook_events— 包含 webhook ID 的事件日志,用于实现幂等性
实现代码
import { neon, NeonQueryFunction } from '@neondatabase/serverless';
import { DodoPayments } from 'dodopayments';
interface WebhookPayload {
business_id: string;
type: string;
timestamp: string;
data: {
payload_type:
| "Payment"
| "Subscription"
| "Refund"
| "Dispute"
| "LicenseKey"
| "CreditLedgerEntry"
| "CreditBalanceLow"
| "AbandonedCheckout"
| "DunningAttempt"
| "EntitlementGrant"
| "Payout";
subscription_id: string;
customer: {
customer_id: string;
email: string;
name: string;
};
product_id: string;
status: string;
recurring_pre_tax_amount: number;
payment_frequency_interval: string;
created_at: string;
next_billing_date: string;
cancelled_at?: string | null;
currency: string;
};
}
// Disable body parsing to access raw body for webhook verification
export const config = {
api: {
bodyParser: false,
},
};
const corsHeaders = {
'Access-Control-Allow-Origin': '*',
'Access-Control-Allow-Headers': 'authorization, x-client-info, apikey, content-type, webhook-id, webhook-signature, webhook-timestamp',
'Access-Control-Allow-Methods': 'POST, OPTIONS',
};
// Helper function for JSON responses
function jsonResponse(data: unknown, status: number = 200) {
return new Response(JSON.stringify(data), {
status,
headers: { ...corsHeaders, 'Content-Type': 'application/json' }
});
}
// Handle subscription events
async function handleSubscriptionEvent(sql: NeonQueryFunction<false, false>, payload: WebhookPayload, status: string) {
if (!payload.data.customer.customer_id || !payload.data.subscription_id) {
throw new Error('Missing required fields: customer_id or subscription_id');
}
console.log('🔄 Processing subscription event:', JSON.stringify(payload, null, 2));
const customer = payload.data.customer;
// Upsert customer (create if doesn't exist, otherwise use existing)
const customerResult = await sql`
INSERT INTO customers (email, name, dodo_customer_id, created_at)
VALUES (${customer.email}, ${customer.name}, ${customer.customer_id}, ${new Date().toISOString()})
ON CONFLICT (dodo_customer_id)
DO UPDATE SET
email = EXCLUDED.email,
name = EXCLUDED.name,
updated_at = ${new Date().toISOString()}
RETURNING id
`;
const customerId = customerResult[0].id;
console.log(`✅ Customer upserted with ID: ${customerId}`);
// Upsert subscription
await sql`
INSERT INTO subscriptions (
customer_id, dodo_subscription_id, product_id, status,
billing_interval, amount, currency, created_at, next_billing_date, cancelled_at, updated_at
)
VALUES (
${customerId}, ${payload.data.subscription_id},
${payload.data.product_id}, ${status},
${payload.data.payment_frequency_interval.toLowerCase()}, ${payload.data.recurring_pre_tax_amount},
${payload.data.currency}, ${payload.data.created_at}, ${payload.data.next_billing_date},
${payload.data.cancelled_at ?? null}, ${new Date().toISOString()}
)
ON CONFLICT (dodo_subscription_id)
DO UPDATE SET
customer_id = EXCLUDED.customer_id,
product_id = EXCLUDED.product_id,
status = EXCLUDED.status,
billing_interval = EXCLUDED.billing_interval,
amount = EXCLUDED.amount,
currency = EXCLUDED.currency,
created_at = EXCLUDED.created_at,
next_billing_date = EXCLUDED.next_billing_date,
cancelled_at = EXCLUDED.cancelled_at,
updated_at = EXCLUDED.updated_at
`;
console.log(`✅ Subscription upserted with ${status} status`)
}
// Handle CORS preflight
export async function OPTIONS() {
return new Response('ok', {
status: 200,
headers: corsHeaders
});
}
// Handle webhook POST request
export async function POST(req: Request) {
try {
// Get raw body for webhook signature verification
const rawBody = await req.text();
console.log('📨 Webhook received');
const DATABASE_URL = process.env.DATABASE_URL;
const API_KEY = process.env.DODO_PAYMENTS_API_KEY;
const WEBHOOK_KEY = process.env.DODO_PAYMENTS_WEBHOOK_KEY;
if (!DATABASE_URL) {
console.error('❌ Missing DATABASE_URL environment variable');
return jsonResponse({ error: 'Server configuration error' }, 500);
}
// Verify required environment variables
if (!API_KEY) {
console.error('❌ DODO_PAYMENTS_API_KEY is not configured');
return jsonResponse({ error: 'API key not configured' }, 500);
}
if (!WEBHOOK_KEY) {
console.error('❌ DODO_PAYMENTS_WEBHOOK_KEY is not configured');
return jsonResponse({ error: 'Webhook verification key not configured' }, 500);
}
// Verify webhook signature (required for security)
const webhookHeaders = {
'webhook-id': req.headers.get('webhook-id') || '',
'webhook-signature': req.headers.get('webhook-signature') || '',
'webhook-timestamp': req.headers.get('webhook-timestamp') || '',
};
try {
const dodoPaymentsClient = new DodoPayments({
bearerToken: API_KEY,
webhookKey: WEBHOOK_KEY,
});
const unwrappedWebhook = dodoPaymentsClient.webhooks.unwrap(rawBody, { headers: webhookHeaders });
console.log('Unwrapped webhook:', unwrappedWebhook);
console.log('✅ Webhook signature verified');
} catch (error) {
console.error('❌ Webhook verification failed:', error);
return jsonResponse({ error: 'Webhook verification failed' }, 401);
}
// Initialize Neon client
const sql = neon(DATABASE_URL);
const payload: WebhookPayload = JSON.parse(rawBody);
const eventType = payload.type;
const eventData = payload.data;
const webhookId = req.headers.get('webhook-id') || '';
console.log(`📋 Webhook payload:`, JSON.stringify(payload, null, 2));
// Check for duplicate webhook-id (idempotency)
if (webhookId) {
const existingEvent = await sql`
SELECT id FROM webhook_events WHERE webhook_id = ${webhookId}
`;
if (existingEvent.length > 0) {
console.log(`⚠️ Webhook ${webhookId} already processed, skipping (idempotency)`);
return jsonResponse({ success: true, message: 'Webhook already processed' });
}
}
// Log webhook event with webhook_id for idempotency
const logResult = await sql`
INSERT INTO webhook_events (webhook_id, event_type, data, processed, created_at)
VALUES (${webhookId || null}, ${eventType}, ${JSON.stringify(eventData)}, ${false}, ${new Date().toISOString()})
RETURNING id
`;
const loggedEventId = logResult[0].id;
console.log('📝 Webhook event logged with ID:', loggedEventId);
console.log(`🔄 Processing: ${eventType} (${eventData.payload_type || 'unknown payload type'})`);
try {
switch (eventType) {
case 'subscription.active':
await handleSubscriptionEvent(sql, payload, 'active');
break;
case 'subscription.cancelled':
await handleSubscriptionEvent(sql, payload, 'cancelled');
break;
case 'subscription.renewed':
console.log('🔄 Subscription renewed - keeping active status and updating billing date');
await handleSubscriptionEvent(sql, payload, 'active');
break;
default:
console.log(`ℹ️ Event ${eventType} logged but not processed (no handler available)`);
}
await sql`
UPDATE webhook_events
SET processed = ${true}, processed_at = ${new Date().toISOString()}
WHERE id = ${loggedEventId}
`;
console.log('✅ Webhook marked as processed');
} catch (processingError) {
console.error('❌ Error processing webhook event:', processingError);
await sql`
UPDATE webhook_events
SET processed = ${false},
error_message = ${processingError instanceof Error ? processingError.message : 'Unknown error'},
processed_at = ${new Date().toISOString()}
WHERE id = ${loggedEventId}
`;
throw processingError;
}
console.log('✅ Webhook processed successfully');
return jsonResponse({
success: true,
event_type: eventType,
event_id: loggedEventId
});
} catch (error) {
console.error('❌ Webhook processing failed:', error);
return jsonResponse({
error: 'Webhook processing failed',
details: error instanceof Error ? error.message : 'Unknown error'
}, 500);
}
}
工作原理
webhook handler 会执行以下操作:- 禁用 body 解析 — 以便访问用于签名验证的原始 body
- 验证签名 — 使用 Dodo Payments SDK 通过 HMAC-SHA256 验证请求
- 检查重复事件 — 使用
webhook-idheader,防止重复处理同一事件 - 记录事件 — 将原始 webhook 存储在
webhook_events表中,以便进行审计追踪 - 处理事件 — 在 Neon 中创建或更新客户和订阅
- 处理错误 — 记录失败,并将事件标记为未处理,以便重试
测试
本地开发:npm start
- 选择你的项目。
- 前往 Deployments → 最新部署。
- 点击 Functions → Logs。
- 前往 Developer → Webhooks。
- 使用你的 Vercel Functions URL 添加 endpoint。
- 选择
subscription.active、subscription.cancelled和subscription.renewed。
常见问题
| 问题 | 解决方案 |
|---|---|
| 验证失败 | 从控制台确认 webhook key 是否正确 |
| 数据库连接错误 | 检查 Neon connection string,并使用 pooled connection |
| Function 超时 | 优化查询;Pro plan 的超时时间更长(60 秒) |
| 环境变量不可用 | 在控制台或 CLI 中设置变量,确保已选择所有环境,然后重新部署 |