Klineo/Docs
Open app ↗

API schemas

WebhookSubscription

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
subscriptionId Yes string Min length: 3; Max length: 160
url Yes string Format: uri
eventTypes Yes Array of string —
secretHash Yes Hash —
active Yes boolean —
maximumAttempts Yes Constant 8 —
createdAt Yes string Format: date-time
secretReference Yes string —

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Exact definition: #/components/schemas/WebhookSubscription in the OpenAPI contract.