API referenceWebhooks
Create a webhook endpoint
POST
/webhook-endpointsRegisters an endpoint and returns its signing secret once. The URL must be https and is immutable afterwards — changing it would need fresh SSRF validation, so replace the endpoint instead. Capped at 20 endpoints per organization.
Requires an API key with one of these roles: admin.
Authorization
bearerAuth AuthorizationBearer <token>
An API key created in Settings → API Keys.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/webhook-endpoints" \ -H "Content-Type: application/json" \ -d '{ "url": "string", "subscribedEventTypes": [ "extraction.completed" ] }'{ "data": { "endpoint": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "url": "string", "name": "string", "description": "string", "enabled": true, "subscribedEventTypes": [ "string" ], "rotationExpiresAt": "2019-08-24T14:15:22Z", "failureCount": 0, "autoDisabledAt": "2019-08-24T14:15:22Z", "autoDisabledReason": "string", "createdAt": "2019-08-24T14:15:22Z", "lastDelivery": { "outcome": "string", "attemptedAt": "2019-08-24T14:15:22Z" } }, "secret": "string" }, "meta": { "requestId": "string", "timestamp": "string" }}