PUT/v1/webhooks0 credits

Set webhook

Optional. The usual path is the Hookest site API page. Use this route when there is no browser. First create returns secret once (whsec_…). Later PUTs update the URL and do not rotate the secret.

Only https. Loopback, private, and link-local hosts are rejected. Deliveries do not follow redirects.

Delivery

POST {url}
X-Hookest-Signature: t={unix},v1={hex}
X-Hookest-Event: prediction.succeeded | prediction.failed
Content-Type: application/json

v1 is HMAC-SHA256 of {t}.{body} with the account secret. body is the same JSON as get prediction.

Failed deliveries retry 10s → 1m → 5m → 30m → 2h, then stop. Needs predict:write on the key. This is a permission on the key, not a request header. Missing it returns 403 api_not_enabled.

Request parameters

Name	In	Type	Required	Description
`url`	body	string	Required	Public HTTPS endpoint. No localhost or private IPs.

Response

{
  "object": "webhook",
  "url": "https://customer.example/hookest",
  "configured": true,
  "secret": "whsec_…"
}

Response fields

Name	Type	Required	Description
`object`	string	Required	Always `webhook`.
`url`	string	Nullable	Configured HTTPS URL, or `null` when none is set.
`configured`	boolean	Required	True only when an HTTPS URL is active.
`secret`	string	Optional	Raw `whsec_…`. Present only on first create. Later PUTs update the URL and omit this key.