Verify Twilio webhooks
Verify that a webhook really came from Twilio before acting on it.
| Identifier | 'twilio' |
| Import | import { verifyTwilio } from 'verihook/twilio' |
| Headers | x-twilio-signature |
| Signature | HMAC-SHA1 of the full public URL followed by the sorted form fields, base64-encoded. JSON bodies are covered by a bodySHA256 query parameter in the signed URL. |
| Replay window | None (the provider sends no timestamp) |
result.eventType |
none (Twilio callbacks have no event name) |
Get your secret
Section titled “Get your secret”Your account’s Auth Token: in the Twilio Console, open Account → API keys & tokens. Use the primary token unless you are rotating.
Store it in an environment variable (TWILIO_AUTH_TOKEN below) and never commit it.
Verify a request
Section titled “Verify a request”import { verifyTwilio } from 'verihook/twilio';
export async function POST(request: Request) { const result = await verifyTwilio(request, process.env.TWILIO_AUTH_TOKEN!);
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('twilio', 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('twilio', process.env.TWILIO_AUTH_TOKEN!, 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/twilio', verihookExpress('twilio', process.env.TWILIO_AUTH_TOKEN!), (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/twilio', { preHandler: verihookFastify('twilio', process.env.TWILIO_AUTH_TOKEN!) }, 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: { TWILIO_AUTH_TOKEN: string }; Variables: VerihookVariables }>();
app.post('/webhooks/twilio', verihookHono('twilio', (c) => c.env.TWILIO_AUTH_TOKEN), (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('twilio') @UseGuards(createVerihookGuard('twilio', process.env.TWILIO_AUTH_TOKEN!)) handle(@Req() req: VerihookNestRequest) { const { eventType, event } = req.verihook!; }}import { createWebhookHandler } from 'verihook/h3';
export default defineEventHandler( createWebhookHandler('twilio', process.env.TWILIO_AUTH_TOKEN!, async (payload, result) => { console.log(result.eventType); }),);import { env } from '$env/dynamic/private';import { createWebhookHandler } from 'verihook/sveltekit';
export const POST = createWebhookHandler('twilio', () => env.TWILIO_AUTH_TOKEN, async (payload, result) => { console.log(result.eventType);});import { createWebhookHandler } from 'verihook/remix';
export const action = createWebhookHandler('twilio', process.env.TWILIO_AUTH_TOKEN!, async (payload, result) => { console.log(result.eventType);});import { createWebhookHandler } from 'verihook/astro';
export const prerender = false;export const POST = createWebhookHandler('twilio', import.meta.env.TWILIO_AUTH_TOKEN, async (payload, result) => { console.log(result.eventType);});import { createWebhookHandler } from 'verihook/lambda';
export const handler = createWebhookHandler('twilio', process.env.TWILIO_AUTH_TOKEN!, 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”- Twilio signs the public URL it called, including the query string. Behind a proxy or tunnel (ngrok, a load balancer), verihook rebuilds it from
x-forwarded-protoandx-forwarded-host. If those aren’t forwarded, pass{ url: 'https://your.public/url' }. result.eventholds the form fields (Body,From,To, …).
Testing
Section titled “Testing”signWebhook from verihook/testing builds a correctly signed Twilio request for your tests:
import { signWebhook } from 'verihook/testing';import { verifyTwilio } from 'verihook/twilio';
const hook = await signWebhook('twilio', { secret: 'twilio_auth_token', payload: { id: 'evt_test' },});
const result = await verifyTwilio( { headers: hook.headers, body: hook.body, url: hook.url }, hook.secret,);// result.valid === trueFrom the command line, npx verihook simulate twilio --url http://localhost:3000/webhooks/twilio 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.