Webhook Endpoints
Create a webhook endpoint
Registers an endpoint and returns the `whsec_` signing secret exactly once, in the response body. Store it now; it cannot be retrieved again. Requires webhooks:write. Max 5 endpoints per community (`422 endpoint_limit` beyond that).
Authorization
apiKey AuthorizationBearer <token>
Community-scoped API key. Send it as Authorization: Bearer arclt_live_.... Keys carry scopes; endpoints that need a specific scope answer 403 missing_scope when the key lacks it.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/webhooks/endpoints" \ -H "Content-Type: application/json" \ -d '{ "url": "https://example.com/webhooks/arcalotl", "event_types": [ "subscription.active", "subscription.cancelled" ] }'{
"id": "whep_01JMZXB3C4",
"server_id": "srv_01JMZX0000",
"url": "https://example.com/webhooks/arcalotl",
"description": "Production billing sync",
"event_types": [
"subscription.active",
"subscription.cancelled"
],
"enabled": true,
"consecutive_failures": 0,
"disabled_at": "2019-08-24T14:15:22Z",
"disabled_reason": "string",
"created_at": "2026-06-01T12:00:00Z",
"updated_at": "2026-07-01T12:00:00Z",
"secret": "whsec_9f8e7d6c5b4a3210fedcba9876543210"
}{
"type": "https://docs.arcalotl.com/api/errors#not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"code": "not_found"
}{
"type": "https://docs.arcalotl.com/api/errors#not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"code": "not_found"
}{
"type": "https://docs.arcalotl.com/api/errors#not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"code": "not_found"
}{
"type": "https://docs.arcalotl.com/api/errors#not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"code": "not_found"
}