# Vern Webhooks

[Vern](https://vern.so) is an AI data-onboarding platform. When a workbook is exported with the
**Webhook** option, Vern POSTs the cleaned rows, in batches, to endpoints you register in an
embedded Svix portal. Svix signs every delivery following
Standard Webhooks, with `svix-*` header names: `svix-id`,
`svix-timestamp` and `svix-signature`. One delivery is one batch of one export.

The body has **no event name**. `workbook.production.export` and `workbook.preview.export` deliver
the same payload shape, and `version` is the export mode (`"1.0"` flat, `"2.0"` nested), not the
event. No header carries the event type either, so register separate endpoints for preview and
production (Vern's docs recommend this so test data never reaches your live database).

## When to Use This Skill

* How do I receive Vern webhooks?
* How do I verify Vern webhook signatures (`svix-signature`)?
* How do I handle `workbook.production.export` and `workbook.preview.export` deliveries?
* How do I reassemble batches of a Vern workbook export (`batch.id`, `batch.index`)?
* Why is my Vern webhook signature verification failing, or rejecting Hookdeck retries?

## Verification (core)

Signed content is `{svix-id}.{svix-timestamp}.{raw body}`. Svix signs it with HMAC-SHA256 using
the base64-decoded secret (the part after `whsec_`), base64-encodes the result, and sends one or
more space-separated `v1,<signature>` entries. Use the official `svix` library, which compares in
constant time. Read the `svix-*` headers, and when `svix-id` is absent fall back to the `webhook-*`
headers (`webhook-id`, `webhook-timestamp`, `webhook-signature`).

```javascript
import { Webhook } from 'svix'; // svix 2.x is ESM-only

const prefix = req.headers['svix-id'] ? 'svix' : 'webhook';
const id = req.headers[`${prefix}-id`];
const timestamp = req.headers[`${prefix}-timestamp`];
const signature = req.headers[`${prefix}-signature`];
// rawBody: the raw Buffer/string, never re-serialized JSON
new Webhook(process.env.VERN_WEBHOOK_SECRET).verify(rawBody, {
  'svix-id': id, 'svix-timestamp': timestamp, 'svix-signature': signature,
  'webhook-id': id, 'webhook-timestamp': timestamp, 'webhook-signature': signature,
}); // throws on a bad signature or a timestamp outside the window
const event = JSON.parse(rawBody.toString('utf8')); // parse only after verify passes

```

```python
from svix.webhooks import Webhook, WebhookVerificationError

wh = Webhook(os.environ["VERN_WEBHOOK_SECRET"])  # "whsec_..."
wh.verify(raw_body, {"svix-id": id, "svix-timestamp": ts, "svix-signature": sig,
                     "webhook-id": id, "webhook-timestamp": ts, "webhook-signature": sig})

```

> **For complete handlers with tests**, see [examples/express/](https://github.com/hookdeck/webhook-skills/tree/main/skills/vern-webhooks/examples/express/), [examples/nextjs/](https://github.com/hookdeck/webhook-skills/tree/main/skills/vern-webhooks/examples/nextjs/), [examples/fastapi/](https://github.com/hookdeck/webhook-skills/tree/main/skills/vern-webhooks/examples/fastapi/).

Each endpoint has its own signing secret, shown for the endpoint in the Svix portal that opens
from Settings > Webhooks in Vern. Vern prints no example value; Svix endpoint secrets look like
`whsec_...`. Keep the full value in `VERN_WEBHOOK_SECRET`. Handlers fail closed: with the variable
unset (or not a `whsec_` value) they return 500 instead of accepting anything. Vern's docs sample
uses the `svix` library with `wh.verify(req.body, req.headers)`; the version here adds the
`webhook-*` fallback.

### Hookdeck retries and replays hit the 5-minute window

The `svix` and `standardwebhooks` libraries always enforce a fixed 5-minute timestamp window, and
it can't be configured. Hookdeck retries and replays resend the **original** `svix-timestamp`, so
the library rejects any retry or replay that happens more than 5 minutes after the original
delivery. If you verify behind Hookdeck (or replay old events), use the manual verifier in
[references/verification.md](https://github.com/hookdeck/webhook-skills/blob/main/skills/vern-webhooks/references/verification.md), where the window can be dropped or
widened. Deduplicate on `svix-id` instead of relying on the timestamp.

## Events and Payloads

Two events are documented (the list may not be exhaustive). Both deliver the same payload
shapes, so the examples dispatch on `version`, not on an event name:

| Event | Triggered When |
| --- | --- |
| `workbook.production.export` | A production export from a workbook |
| `workbook.preview.export` | A staging/preview export from a workbook |

| `version` | Mode | Body |
| --- | --- | --- |
| `"1.0"` | Flat | `{version, workbook_id, external_id, batch, sheets}`; `sheets[].data[]` are row objects (column keys, `errors`, `row_index`) |
| `"2.0"` | Nested | `{version, workbook_id, company_name, external_id, export_mode, batch, root_sheets, data}`; `data` is keyed by root sheet name, records carry `children` |

Each delivery is one batch (flat: about 256 KB target, 512 KB ceiling; nested: up to 50 root
records). Reassemble by grouping on `batch.id`, ordering by `batch.index`, and treating
`batch.index === batch.total - 1` as the last one. Batches can arrive in any order and retries
can deliver one twice, so make the handler idempotent. See
[references/overview.md](https://github.com/hookdeck/webhook-skills/blob/main/skills/vern-webhooks/references/overview.md) for the full payload reference.

## Environment Variables

```bash
# Signing secret of the webhook endpoint in the Svix portal (starts with whsec_)
VERN_WEBHOOK_SECRET=whsec_xxxxx

```

## Local Development

```bash
# Start tunnel (no account needed)
npx hookdeck-cli listen 3000 vern --path /webhooks/vern

```

Add the tunnel URL as an endpoint in the Svix portal (Settings > Webhooks in Vern), subscribe it
to one or both events, then export a workbook with the Webhook option. Svix Play gives you a
throwaway URL for checking that an export fires before your real endpoint is wired up.

## Reference Materials

* [references/overview.md](https://github.com/hookdeck/webhook-skills/blob/main/skills/vern-webhooks/references/overview.md) - Vern webhook concepts, events, payload shapes, batching, delivery
* [references/setup.md](https://github.com/hookdeck/webhook-skills/blob/main/skills/vern-webhooks/references/setup.md) - Add an endpoint in the Svix portal, get the secret, watch deliveries
* [references/verification.md](https://github.com/hookdeck/webhook-skills/blob/main/skills/vern-webhooks/references/verification.md) - Svix verification details, header fallback, manual verifier, timestamp window