Create or update a project event definition

Creates a definition for an event type. If a definition with the same name already exists, Kapso updates its editable metadata and returns it. If the existing definition is archived, this request restores it. Use /events when you want to emit an actual event occurrence.

post/event-definitions

Request

Base URL
https://api.kapso.ai/platform/v1
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/kapso/apis/kapso-platform-api/docs/event-definitions/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

Event name. Must be lowercase and may contain optional dot-separated segments. Each segment starts with a lowercase letter and may contain lowercase letters, numbers, and underscores. Maximum 128 characters.

descriptionstring nullable

Human-readable description of what this event means

property_schemaobject

Declared properties for this event. Values are keyed by property name.

Example request

{
  "name": "conversation.csat_scored",
  "property_schema": {
    "score": {
      "type": "number"
    },
    "reason": {
      "type": "string"
    }
  }
}

Response

Existing definition updated

Example response

{
  "data": {
    "name": "conversation.csat_scored",
    "property_schema": {
      "score": {
        "type": "number"
      },
      "reason": {
        "type": "string"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.