Hanzo
OpenapiWebhook

Returns one of the caller org's webhook endpoints with its 7-day delivery and…

Returns one of the caller org's webhook endpoints with its 7-day delivery and failure counts, signing secret redacted.

GET /v1/webhook/{id}

Addresshttps://api.hanzo.ai/v1/webhook/{id}
MethodGET
Operationget_webhook_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one of the caller org's webhook endpoints with its 7-day delivery and failure counts, signing secret redacted. An id another org owns reads as not found, so the response cannot confirm that it exists.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyes

Response

StatusBodyMeaning
200Endpointok

200 body — 11 fields.

FieldInTypeAlwaysDescription
createdbodystringCreatedAt is when the endpoint was registered, RFC3339 in UTC — stored in that spelling because it sorts as a string.
deliveries7dbodyintegerDeliveries7d is how many deliveries SETTLED in the trailing 7 days — the attempts that ended ok or failed, so a delivery still retrying is in neither counter…
descriptionbodystringDescription is the operator's own label for the endpoint.
eventsbodystring[]Events are the subject patterns this endpoint subscribes to ("commerce.order.>").
failures7dbodyintegerFailures7d is how many of those settled as failed — the subscriber never accepted it and no further attempt will be made.
idbodystringID is the endpoint's handle, server-minted and stable for its life.
orgbodystringOrg is the tenant that owns the endpoint, taken from the validated principal rather than from any request field.
secretbodystringSecret is the HMAC-SHA256 signing key a subscriber recomputes the signature with.
statusbodystringStatus is "active" or "disabled" — nothing else is accepted.
updatedbodystringUpdatedAt is when its url, events, status or description last changed.
urlbodystringURL is where the POST goes.

Failure carries the platform error shape — see Errors.

Examples

hanzo webhooks get <id>

Webhook API · All Hanzo APIs · Interactive reference

How is this guide?

On this page