Webhooks
Payload Examples
Example JSON payloads for webhook events.
Payload Examples
Customer Creation
{
"name": "CUSTOMER_CREATION",
"type": "com.kaiten.customer.v1.created",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Acme Corporation",
"slug": "acme-corporation",
"externalCustomerId": "crm_12345",
"organizationId": "org-uuid",
"createdAt": "2025-01-15T10:30:00Z"
}
}Instance Creation
{
"name": "INSTANCE_CREATION",
"type": "com.kaiten.instance.v1.created",
"data": {
"id": "instance-uuid",
"name": "Acme Production",
"slug": "acme-production",
"customerId": "customer-uuid",
"licenseId": "license-uuid",
"deploymentZoneId": null,
"startLicenseDate": "2025-01-15T00:00:00Z",
"endLicenseDate": "2026-01-15T00:00:00Z",
"organizationId": "org-uuid",
"createdAt": "2025-01-15T10:31:00Z"
}
}License Creation
{
"name": "LICENSE_CREATION",
"type": "com.kaiten.license.v1.created",
"data": {
"id": "license-uuid",
"name": "Enterprise",
"slug": "enterprise",
"type": "PAID",
"version": 1,
"versionName": "v1",
"isActive": true,
"isDefault": false,
"organizationId": "org-uuid"
}
}Feature Flag Creation
{
"name": "FEATUREFLAG_CREATION",
"type": "com.kaiten.featureFlag.v1.created",
"data": {
"id": "flag-uuid",
"name": "Beta Feature",
"slug": "beta-feature",
"type": "boolean",
"enabled": true,
"organizationId": "org-uuid"
}
}Entitlement Usage Reached
{
"name": "INSTANCE_ENTITLEMENT_USAGE_REACHED",
"type": "com.kaiten.instance.v1.entitlementUsageReached",
"data": {
"instanceId": "instance-uuid",
"instanceSlug": "acme-production",
"entitlementId": "entitlement-uuid",
"entitlementSlug": "api-calls",
"currentUsage": 1000,
"threshold": 1000,
"organizationId": "org-uuid"
}
}
