Verify Square webhooks

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

Identifier	'square'
Import	import { verifySquare } from 'verihook/square'
Headers	x-square-hmacsha256-signature
Signature	HMAC-SHA256 of <notification URL><raw body>, base64-encoded.
Replay window	None (the provider sends no timestamp)
result.eventType	the body’s type, e.g. payment.updated

Get your secret

The subscription’s Signature Key: in the Square Developer Console, open your application → Webhooks → Subscriptions and select the subscription.

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

Verify a request

import { verifySquare } from 'verihook/square';

export async function POST(request: Request) {
  const result = await verifySquare(request, process.env.SQUARE_WEBHOOK_SIGNATURE_KEY!);

  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('square', request, secret) from verihook does the same. Read why the raw body matters if verification fails behind a body parser.

Framework examples

Next.js

app/api/webhooks/square/route.ts

import { createWebhookHandler } from 'verihook/next';

export const POST = createWebhookHandler('square', process.env.SQUARE_WEBHOOK_SIGNATURE_KEY!, async (payload, result) => {
  // Runs only for a valid signature
  console.log(result.eventType, result.event);
});

Express

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/square', verihookExpress('square', process.env.SQUARE_WEBHOOK_SIGNATURE_KEY!), (req, res) => {
  const { eventType, event } = (req as typeof req & VerihookRequestAdditions).verihook!;
  res.json({ received: true });
});

Fastify

import Fastify from 'fastify';
import { verihookFastify, verihookRawBody, type VerihookFastifyRequest } from 'verihook/fastify';

const app = Fastify();
await app.register(verihookRawBody);

app.post('/webhooks/square', { preHandler: verihookFastify('square', process.env.SQUARE_WEBHOOK_SIGNATURE_KEY!) }, async (request) => {
  const { eventType, event } = (request as typeof request & VerihookFastifyRequest).verihook!;
  return { received: true };
});

Hono

import { Hono } from 'hono';
import { verihookHono, type VerihookVariables } from 'verihook/hono';

const app = new Hono<{ Bindings: { SQUARE_WEBHOOK_SIGNATURE_KEY: string }; Variables: VerihookVariables }>();

app.post('/webhooks/square', verihookHono('square', (c) => c.env.SQUARE_WEBHOOK_SIGNATURE_KEY), (c) => {
  const { eventType, event } = c.get('verihook');
  return c.json({ received: true });
});

NestJS

// 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('square')
  @UseGuards(createVerihookGuard('square', process.env.SQUARE_WEBHOOK_SIGNATURE_KEY!))
  handle(@Req() req: VerihookNestRequest) {
    const { eventType, event } = req.verihook!;
  }
}

Nuxt / h3

server/api/webhooks/square.post.ts

import { createWebhookHandler } from 'verihook/h3';

export default defineEventHandler(
  createWebhookHandler('square', process.env.SQUARE_WEBHOOK_SIGNATURE_KEY!, async (payload, result) => {
    console.log(result.eventType);
  }),
);

SvelteKit

src/routes/webhooks/square/+server.ts

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

export const POST = createWebhookHandler('square', () => env.SQUARE_WEBHOOK_SIGNATURE_KEY, async (payload, result) => {
  console.log(result.eventType);
});

Remix / React Router

app/routes/webhooks.square.ts

import { createWebhookHandler } from 'verihook/remix';

export const action = createWebhookHandler('square', process.env.SQUARE_WEBHOOK_SIGNATURE_KEY!, async (payload, result) => {
  console.log(result.eventType);
});

Astro

src/pages/api/webhooks/square.ts

import { createWebhookHandler } from 'verihook/astro';

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

AWS Lambda

import { createWebhookHandler } from 'verihook/lambda';

export const handler = createWebhookHandler('square', process.env.SQUARE_WEBHOOK_SIGNATURE_KEY!, 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

• Square signs the notification URL exactly as you registered it. Behind a proxy, forward x-forwarded-proto and x-forwarded-host, or pass { url: 'https://your.public/url' }.

Testing

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

import { signWebhook } from 'verihook/testing';
import { verifySquare } from 'verihook/square';

const hook = await signWebhook('square', {
  secret: 'square_signature_key',
  payload: { id: 'evt_test' },
});

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

From the command line, npx verihook simulate square --url http://localhost:3000/webhooks/square 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.

Square’s webhook documentation