NotifHQDocumentation
Everything needed to send the first notification and to prove what happened to it.
API reference
Every endpoint in the NotifHQ API, generated from the OpenAPI document the router is checked against.
SDK
The TypeScript client, and the request that sends your first notification.
Webhooks
Every event NotifHQ will send you, how it is signed, and how to verify it.
Architecture
The rails a request passes through, and the workers that run them.
OpenAPI document
The machine-readable contract. The router is generated from it, so it cannot describe an endpoint that does not exist.
Getting a key
A workspace key is issued in the developer console at dev.notifhq.com. It is shown once, at creation, and is not recoverable afterwards — store it as a secret, never in a browser.
Every request carries it as Authorization: Bearer <key>.