Skip to main content
POST
Register a webhook endpoint

Authorizations

Authorization
string
header
required

API key starting with zt_live_ (production) or zt_test_ (sandbox). Get your key at https://developers.zebratruth.ai

Headers

Idempotency-Key
string<uuid>
required

Unique request identifier to prevent duplicate execution and double-charging. Generate a new UUID for each distinct request. Reuse the same key to safely retry.

X-Recent-Auth-Proof
string
required

Body

application/json
url
string<uri>
required

HTTPS endpoint. Rejected with 400 invalid_url (bad URL, wrong protocol, embedded credentials, fragment) or url_not_allowed (disallowed, unresolvable, or private address).

events
string[]

Event names to deliver. * subscribes to every event.

Minimum array length: 1

Response

Endpoint registered

webhookId
string
secret
string

Shown once, here only. Verify X-ZebraTruth-Signature with it.

Example:

"whsec_0123456789abcdef0123456789abcdef"

url
string<uri>
events
string[]
message
string