Webhooks API
Base path /api/webhooks — JWT required. Register endpoints to receive events (e.g. when sources are added or a research run completes); delivery runs on the background queue with retries.
Endpoints
| Method | Path | Purpose |
|---|---|---|
| GET | /api/webhooks | List your webhooks |
| POST | /api/webhooks | Register a webhook |
| PUT | /api/webhooks/:id | Update a webhook |
| DELETE | /api/webhooks/:id | Delete a webhook |
| POST | /api/webhooks/:id/test | Send a test delivery |
Delivery
Deliveries are dispatched asynchronously and retried on failure. Use POST /:id/test to verify your endpoint receives and acknowledges payloads before relying on live events.
External apps can also register a delivery endpoint through the Service API (
POST /service/v1/projects/:id/webhooks) with awebhook-scoped API key.
→ Related: Service API · Authentication