Verify Svix webhooks
Verify that a webhook really came from Svix before acting on it.
| Identifier | 'svix' |
| Import | import { verifySvix } from 'verihook/svix' |
| Headers | svix-idsvix-timestampsvix-signatureor webhook-id / webhook-timestamp / webhook-signature |
| Signature | HMAC-SHA256 of <id>.<timestamp>.<raw body>, keyed with the base64 secret, sent as v1,<base64>. Standard Webhooks headers (webhook-*) are accepted too. |
| Replay window | 300 seconds (options.tolerance) |
result.eventType |
the body’s type |
Get your secret
Section titled “Get your secret”The endpoint’s Signing Secret (whsec_...) from the Svix App Portal or dashboard.
Store it in an environment variable (SVIX_WEBHOOK_SECRET below) and never commit it.
Verify a request
Section titled “Verify a request”import { verifySvix } from 'verihook/svix';
export async function POST(request: Request) { const result = await verifySvix(request, process.env.SVIX_WEBHOOK_SECRET!);
if (!result.valid) { console.warn(result.code, result.reason, result.hint); return new Response('Invalid signature', { status: 401 }); }
console.log(result.eventType, result.event); return Response.json({ received: true });}request can be a Fetch Request or { headers, body, url? } with the raw body. verifyWebhook('svix', request, secret) from verihook does the same. Read why the raw body matters if verification fails behind a body parser.
Framework examples
Section titled “Framework examples”import { createWebhookHandler } from 'verihook/next';
export const POST = createWebhookHandler('svix', process.env.SVIX_WEBHOOK_SECRET!, async (payload, result) => { // Runs only for a valid signature console.log(result.eventType, result.event);});import express from 'express';import { verihookExpress, type VerihookRequestAdditions } from 'verihook/express';
const app = express();
// Register before express.json(), or keep express.json() off this routeapp.post('/webhooks/svix', verihookExpress('svix', process.env.SVIX_WEBHOOK_SECRET!), (req, res) => { const { eventType, event } = (req as typeof req & VerihookRequestAdditions).verihook!; res.json({ received: true });});import Fastify from 'fastify';import { verihookFastify, verihookRawBody, type VerihookFastifyRequest } from 'verihook/fastify';
const app = Fastify();await app.register(verihookRawBody);
app.post('/webhooks/svix', { preHandler: verihookFastify('svix', process.env.SVIX_WEBHOOK_SECRET!) }, async (request) => { const { eventType, event } = (request as typeof request & VerihookFastifyRequest).verihook!; return { received: true };});import { Hono } from 'hono';import { verihookHono, type VerihookVariables } from 'verihook/hono';
const app = new Hono<{ Bindings: { SVIX_WEBHOOK_SECRET: string }; Variables: VerihookVariables }>();
app.post('/webhooks/svix', verihookHono('svix', (c) => c.env.SVIX_WEBHOOK_SECRET), (c) => { const { eventType, event } = c.get('verihook'); return c.json({ received: true });});// main.ts: NestFactory.create(AppModule, { rawBody: true })import { Controller, Post, Req, UseGuards } from '@nestjs/common';import { createVerihookGuard, type VerihookNestRequest } from 'verihook/nestjs';
@Controller('webhooks')export class WebhooksController { @Post('svix') @UseGuards(createVerihookGuard('svix', process.env.SVIX_WEBHOOK_SECRET!)) handle(@Req() req: VerihookNestRequest) { const { eventType, event } = req.verihook!; }}import { createWebhookHandler } from 'verihook/h3';
export default defineEventHandler( createWebhookHandler('svix', process.env.SVIX_WEBHOOK_SECRET!, async (payload, result) => { console.log(result.eventType); }),);import { env } from '$env/dynamic/private';import { createWebhookHandler } from 'verihook/sveltekit';
export const POST = createWebhookHandler('svix', () => env.SVIX_WEBHOOK_SECRET, async (payload, result) => { console.log(result.eventType);});import { createWebhookHandler } from 'verihook/remix';
export const action = createWebhookHandler('svix', process.env.SVIX_WEBHOOK_SECRET!, async (payload, result) => { console.log(result.eventType);});import { createWebhookHandler } from 'verihook/astro';
export const prerender = false;export const POST = createWebhookHandler('svix', import.meta.env.SVIX_WEBHOOK_SECRET, async (payload, result) => { console.log(result.eventType);});import { createWebhookHandler } from 'verihook/lambda';
export const handler = createWebhookHandler('svix', process.env.SVIX_WEBHOOK_SECRET!, async (payload, result) => { console.log(result.eventType);});Each adapter responds 401 to an invalid signature, 413 to a body over maxBodySize (2 MB by default) and 200 to a duplicate when you pass a dedupeStore.
Things to know
Section titled “Things to know”- Resend and Clerk send Svix signatures. Use their own identifiers (
'resend','clerk') for clearer logs; the check is the same. - During secret rotation Svix sends several signatures separated by spaces. Any one matching is enough.
Testing
Section titled “Testing”signWebhook from verihook/testing builds a correctly signed Svix request for your tests:
import { signWebhook } from 'verihook/testing';import { verifySvix } from 'verihook/svix';
const hook = await signWebhook('svix', { secret: 'whsec_dGVzdF9zZWNyZXRfa2V5X2Zvcl9zdml4XzEyMw==', payload: { id: 'evt_test' },});
const result = await verifySvix( { headers: hook.headers, body: hook.body, url: hook.url }, hook.secret,);// result.valid === trueFrom the command line, npx verihook simulate svix --url http://localhost:3000/webhooks/svix sends one to your local server.
See Testing your handlers for supertest and Fetch Request examples.
Troubleshooting
Section titled “Troubleshooting”Failed results carry a code and often a hint with the likely cause. See Troubleshooting for each error code.