Webhooks

Webhooks must be enabled in configuration. See Webhooks concept for setup and signature verification.

Register a webhook

POST /api/kiwi/webhooks

string

required

HTTPS endpoint to receive POST notifications.

string

default:"**"

Glob pattern to filter which file changes trigger this webhook. Defaults to all files.

curl -X POST 'http://localhost:3333/api/kiwi/webhooks' \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/hook", "path_glob": "concepts/**"}'

string

Unique webhook identifier.

string

Registered endpoint URL.

string

Path filter pattern.

string

HMAC signing secret (only returned at creation).

string

ISO 8601 creation timestamp.

boolean

Whether the webhook is active.

Returns 503 if webhooks are not enabled in configuration.

List webhooks

GET /api/kiwi/webhooks

curl 'http://localhost:3333/api/kiwi/webhooks'

Returns an array of webhooks. The secret field is omitted from list responses.

Delete a webhook

DELETE /api/kiwi/webhooks/:id

curl -X DELETE 'http://localhost:3333/api/kiwi/webhooks/wh_abc123'

Returns 204 No Content on success.

Last modified on May 4, 2026

REST API

CLI

Register a webhook

List webhooks

Delete a webhook

​Register a webhook

​List webhooks

​Delete a webhook

Register a webhook

List webhooks

Delete a webhook