Hanzo

Webhook

Package webhooks is how your app hears about events: register an endpoint, pick the events, get each one delivered and signed.

Package webhooks is how your app hears about events: register an endpoint, pick the events, get each one delivered and signed.

Base URLhttps://api.hanzo.ai
Operations8
AuthAuthorization: Bearer $HANZO_API_KEY

Specification

Specification pending — no HIP in hanzoai/hips declares capability: webhook yet. What this capability serves is below, from the API document; what it is — the store it owns, how it meters, what it publishes — is written as a HIP under HIP-0139.

Four surfaces

SurfaceReaches this capability asCoverage
RESTwebhook at its own prefix8 operations
CLIhanzo webhooks …8 of 8
SDKno published client declares one yet — regenerating the clients is what adds them
MCPtool webhooks on https://api.hanzo.ai/v1/mcp7 operations, 1 under the document's own id — ask describe for the rest

Quickstart

export HANZO_API_KEY=sk-...   # console.hanzo.ai → API keys

Then the first call — a read that needs nothing but the key. GET /v1/webhook, operation get_webhook:

hanzo webhooks list

Answers 200 with object — ok.

Endpoints

EndpointWhat it does
GET /v1/webhook/{id}/deliveriesReturns one endpoint's per-attempt delivery log, newest first — the record of what was sent, what the subscriber answered, and how long it took.
POST /v1/webhook/{id}/secretMints a NEW HMAC signing secret for the endpoint and answers the endpoint WITH it — the only other response besides create that ever carries a secret.
POST /v1/webhook/{id}/testSends ONE signed test event to the endpoint right now and answers the outcome inline, so the console can show whether the subscriber is reachable…
GET /v1/webhook/{id}Returns one of the caller org's webhook endpoints with its 7-day delivery and failure counts, signing secret redacted.
PUT /v1/webhook/{id}Replaces the editable fields of one of the caller org's endpoints — url, events, status and description — and answers the stored row with its secret…
DELETE /v1/webhook/{id}Removes one of the caller org's webhook endpoints and answers 204 with no body.
GET /v1/webhookReturns every webhook endpoint the caller's org has registered, newest first, each with its 7-day delivery and failure counts.
POST /v1/webhookRegisters a new webhook subscription for the caller's org and answers 201 with the endpoint INCLUDING its freshly minted signing secret.

All Hanzo APIs · Interactive reference

How is this guide?

On this page