Verify Standard Webhooks webhooks

Verify that a webhook really came from Standard Webhooks before acting on it.


Identifier	`'standard-webhooks'`
Import	`import { verifyStandardWebhooks } from 'verihook/standard-webhooks'`
Headers	`webhook-id` `webhook-timestamp` `webhook-signature`
Signature	Standard Webhooks: HMAC-SHA256 of `<webhook-id>.<webhook-timestamp>.<raw body>`, keyed with the base64 secret, sent as `v1,<base64>`.
Replay window	300 seconds (`options.tolerance`)
`result.eventType`	the body’s `type`

Get your secret

The endpoint’s signing secret (whsec_...), from the sender’s dashboard. If you send the webhooks with verihook/send, it’s the secret from generateWebhookSecret().

Store it in an environment variable (WEBHOOK_SECRET below) and never commit it.

Verify a request

import { verifyStandardWebhooks } from 'verihook/standard-webhooks';

export async function POST(request: Request) {
  const result = await verifyStandardWebhooks(request, process.env.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('standard-webhooks', request, secret) from verihook does the same. Read why the raw body matters if verification fails behind a body parser.

Framework examples

import { createWebhookHandler } from 'verihook/next';

export const POST = createWebhookHandler('standard-webhooks', process.env.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 route
app.post('/webhooks/standard-webhooks', verihookExpress('standard-webhooks', process.env.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/standard-webhooks', { preHandler: verihookFastify('standard-webhooks', process.env.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: { WEBHOOK_SECRET: string }; Variables: VerihookVariables }>();

app.post('/webhooks/standard-webhooks', verihookHono('standard-webhooks', (c) => c.env.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('standard-webhooks')
  @UseGuards(createVerihookGuard('standard-webhooks', process.env.WEBHOOK_SECRET!))
  handle(@Req() req: VerihookNestRequest) {
    const { eventType, event } = req.verihook!;
  }
}

import { createWebhookHandler } from 'verihook/h3';

export default defineEventHandler(
  createWebhookHandler('standard-webhooks', process.env.WEBHOOK_SECRET!, async (payload, result) => {
    console.log(result.eventType);
  }),
);

import { env } from '$env/dynamic/private';
import { createWebhookHandler } from 'verihook/sveltekit';

export const POST = createWebhookHandler('standard-webhooks', () => env.WEBHOOK_SECRET, async (payload, result) => {
  console.log(result.eventType);
});

import { createWebhookHandler } from 'verihook/remix';

export const action = createWebhookHandler('standard-webhooks', process.env.WEBHOOK_SECRET!, async (payload, result) => {
  console.log(result.eventType);
});

import { createWebhookHandler } from 'verihook/astro';

export const prerender = false;
export const POST = createWebhookHandler('standard-webhooks', import.meta.env.WEBHOOK_SECRET, async (payload, result) => {
  console.log(result.eventType);
});

import { createWebhookHandler } from 'verihook/lambda';

export const handler = createWebhookHandler('standard-webhooks', process.env.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

Any service that follows the spec works, as do webhooks sent with verihook/send.
During secret rotation several signatures are sent, separated by spaces. Any one matching is enough.
The dedupe key is the signed webhook-id.

Testing

signWebhook from verihook/testing builds a correctly signed Standard Webhooks request for your tests:

import { signWebhook } from 'verihook/testing';
import { verifyStandardWebhooks } from 'verihook/standard-webhooks';

const hook = await signWebhook('standard-webhooks', {
  secret: 'whsec_dGVzdF9zZWNyZXRfa2V5X2Zvcl9zdml4XzEyMw==',
  payload: { id: 'evt_test' },
});

const result = await verifyStandardWebhooks(
  { headers: hook.headers, body: hook.body, url: hook.url },
  hook.secret,
);
// result.valid === true

From the command line, npx verihook simulate standard-webhooks --url http://localhost:3000/webhooks/standard-webhooks sends one to your local server.

See Testing your handlers for supertest and Fetch Request examples.

Troubleshooting

Failed results carry a code and often a hint with the likely cause. See Troubleshooting for each error code.

Standard Webhooks’s webhook documentation