Docs/Get started

Installation

Install the sender, the verifier, or both.

Each package is installed on its own. A typical setup puts the sender in the app that emits events and the verifier in the apps that receive them.

The sender

@typedhook/sdk sends webhooks. Install it with the schema library you already use. Any library that implements Standard Schema works: zod 3.24 or later, valibot and arktype.

npm install @typedhook/sdk zod

It needs Node 20 or later, or Bun. It uses the global fetch and WebCrypto, and has no dependencies.

The verifier

@typedhook/verify verifies webhooks you receive. It has no dependencies and only uses WebCrypto, so it runs on Node 20+, Bun, Deno, Cloudflare Workers and edge runtimes.

npm install @typedhook/verify

You don't need the sender to use it. It verifies any webhook signed in the Standard Webhooks format, including ones sent through Svix.

The Prisma outbox

@typedhook/prisma stores the outbox in Postgres with Prisma. Install it next to the sender, which is a peer dependency.

npm install @typedhook/sdk @typedhook/prisma

Then add the outbox model to your schema. See Prisma adapter.

Module formats

All three packages ship ESM and CommonJS builds with their type declarations. Under Bun, the packages resolve to their TypeScript sources.

Edit on GitHubLast updated on October 14, 2026

On this page

For coding agents

Every page is available as Markdown. Point your agent at the full docs in one file.