v1
latestOpenAPI 3.1.02026-07-22115189303.8 KBEvents
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
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"
}
}
}
]
}