Skip to main content
POST
Create or update a project event definition

Authorizations

X-API-Key
string
header
required

Body

application/json
name
string
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.

Required string length: 1 - 128
Pattern: ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
Example:

"conversation.csat_scored"

description
string | null

Human-readable description of what this event means

property_schema
object

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

Example:

Response

Existing definition updated

data
object
required