Docs
Sign in

Change a webhook endpoint, or switch it on or off.

Switching a disabled endpoint on starts it from now; events from the time it was off are not sent.

PATCH/api/v1/webhooks/{id}

Scopeconfig

When an API key calls it, the timeline records who did what and the outcome. No query parameters.

Path parameters.

idstringrequired

The webhook endpoint's id.

Body.

urlstring

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.

eventsarray

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.

enabledboolean

Off: the endpoint is saved but nothing is sent.

Response.

200 OK: a Webhook. The example has placeholder values.

422 validation_failed
The body does not match its schema; each problem is in details.