List all instances Create a new instance Get an instance by slug Patch an instance Delete an instance Update an instance List audit trail entries for an instance List all entitlements usage metrics Get entitlement usage metrics for an instance Report entitlement usage metric for an instance Get an instance integration Create an instance integration Delete an instance integration Update an instance integration Get an instance by integration external ID Upsert an instance by integration external ID Instance Entitlement Cap Exceeded Webhook Entitlement Usage Period Rolled Over Webhook Instance Entitlement Usage Reached Webhook Entitlement Usage Report Accepted Webhook Entitlement Usage Report Rejected Webhook Instance Entitlement Usage Warning Threshold Reached Webhook Instance Entitlement Value Read Webhook Instance Created Webhook Instance Deleted Webhook Instance Deployed Webhook Instance Lifecycle Stage Changed Webhook Instance Migrated Webhook Instance Status Changed Webhook Instance Updated Webhook

Instance Entitlement Cap Exceeded Webhook

Triggered when a SOFT-enforcement entitlement's usage crosses from below the cap to above it. Fires once per crossing.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

data*

headers?

name*string

Event name

Value in"INSTANCE_ENTITLEMENT_CAP_EXCEEDED"

type*string

Event type

Value in"com.kaiten.instance.entitlement.v1.cap_exceeded"

Response Body

Example Requests

POST/com.kaiten.instance.entitlement.v1.cap_exceeded

Upsert an instance by integration external ID

Create or partially update an instance resolved through adapter + external ID. Missing fields are left unchanged.

Entitlement Usage Period Rolled Over Webhook

Triggered once per usage window closed by a report: the entitlement's own stored bucket, and one synthetic event per window skipped entirely since the last report.