Skip to main content
PUT
Set Webhook Endpoint
Registers the single URL every order and return event for this account is POSTed to.
A signing secret is generated on first registration and returned in the response. Replacing the URL later keeps the existing secret, so moving your endpoint never invalidates the verification you already have in place.
This is how an API-key-only caller registers a webhook. An agent whose key came from POST /agent/orders has no dashboard login, so this endpoint is its only route to event delivery.
Store webhook_secret and check the X-Webhook-Signature header on every delivery — see Webhooks.

Authorizations

Authorization
string
header
required

Zinc API key (Bearer zn_...)

Headers

authorization
string | null

Body

application/json

Body for PUT /webhooks/endpoint: the single URL Zinc delivers to.

url
string
required

Absolute http(s) URL that receives order and return events.

Example:

"https://example.com/zinc/webhook"

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