Register a webhook endpoint.
Koidog POSTs matching timeline events to url (https, not a private address).
POST/api/v1/webhooks
Scopeconfig
The answer carries the signing secret once. Each delivery has Koidog-Timestamp and Koidog-Signature: v1=<hex HMAC-SHA256 of "<timestamp>.<raw body>">. A failed delivery is retried for about 21 hours. Koidog switches an endpoint off after 50 failed attempts in a row, or after 24 hours in which every attempt failed, with a webhook.disabled event; PATCH /webhooks/{id} with enabled: true switches it on again. When an API key calls it, the timeline records who did what and the outcome. No path or query parameters.
Headers.
Idempotency-Keystring
Makes a retry safe: the same key with the same request returns the first answer and does nothing else.
Body.
urlstringrequired
Where deliveries are POSTed: https, and not a private address. At most 2000 characters. A URL.
descriptionstring
A note for you; Koidog does not use it. At most 200 characters. Default empty.
eventsarrayrequired
Which events to send. Each entry is * (every event), an event kind such as run.started, or a prefix ending in .* that matches at least one kind, such as run.*. webhook.test is also taken. Anything else is refused with 422 validation_failed. 1 to 50 items.
projectIdstring | null
Only events of this project's crews. Events that belong to no crew are then not sent. At least 5 characters. Default null.
enabledboolean
Off: the endpoint is saved but nothing is sent. Default true.
Response.
201 Created: a JSON object. The example has placeholder values.
- 422 validation_failed
- The body does not match its schema; each problem is in
details.