Skip to main content
GET
Get Webhook Endpoint
Returns the account’s webhook URL and its HMAC signing secret. Both are null until PUT /webhooks/endpoint registers one.
Use webhook_secret to verify the X-Webhook-Signature header on every delivery — see Webhooks for the payload shape and the verification recipe.
A zn_test_ key reads the sandbox account’s endpoint, which is registered separately from the live one.

Authorizations

Authorization
string
header
required

Zinc API key (Bearer zn_...)

Headers

authorization
string | null

Response

Successful Response

The caller's webhook endpoint: where events go and the HMAC secret that signs them. Both are null until registered.

webhook_url
string | null
required
webhook_secret
string | null
required