List project event definitions

Returns the event definitions registered for the project associated with your API key. Definitions describe event names, meanings, and property schemas. Emitting a new event through /events can create a minimal definition automatically, but use this endpoint when you want to manage definition metadata directly.

get/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/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

include_archivedboolean

Include archived event definitions in the response. Archived definitions are hidden by default.

Response

Success

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.