Releasesv0.1.0
Api referenceEndpointsWebhooks

An event sent to a registered endpoint

Verify webhook-signature (v1, + base64 HMAC-SHA256 of {webhook-id}.{webhook-timestamp}.{body} keyed by the base64-decoded secret after whsec_), refuse a timestamp more than 5 minutes off, and deduplicate on webhook-id. Answer 2xx within 15 seconds; anything else is retried.

Header Parameters

webhook-id*string
webhook-timestamp*string

Unix seconds

webhook-signature*string

Request Body

application/json
  1. body

The body of every delivery. It names what changed, never a health value: read the data with the API. Signed per Standard Webhooks (headers webhook-id, webhook-timestamp, webhook-signature).

id*string
Formatuuid
type*|string
timestamp*string
Formatdate-time
test?boolean

Present on events sent by the test route only. Such an event describes nothing that happened.

data*

Response Body

Accepted.

Example Requests

The body of every delivery. It names what changed, never a health value: read the data with the API. Signed per Standard Webhooks (headers webhook-id, webhook-timestamp, webhook-signature).

POST/event

Edit on GitHub