Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kiwifs.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Register a webhook

POST /api/kiwi/webhooks
​
url
string
required
HTTPS endpoint to receive POST notifications.
​
path_glob
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/**"}'
​
id
string
Unique webhook identifier.
​
url
string
Registered endpoint URL.
​
path_glob
string
Path filter pattern.
​
secret
string
HMAC signing secret (only returned at creation).
​
created_at
string
ISO 8601 creation timestamp.
​
enabled
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