Skip to main content
POST
Defines a new event for the project. Event names and property names accept ASCII letters, digits, and underscores only, and must be 64 characters or fewer.

Authorizations

string | header
required
Project API key header of the form Bearer AS_<key>.

Body

string
required
Unique name of the event within the project. ASCII letters, digits, and underscores only.Maximum length: 64Example: "order_completed"
string
Optional human-readable description.Example: "Fired when a customer completes a checkout"
object[]
Schema for the event’s custom properties. Up to 50 properties per event.

Response

Event created successfully (201)
boolean
Indicates if the request was successfulExample: true
object
The created event definition

Error Responses

object
object
Returned when an event with the same eventName already exists in the project.
object
Returned when the project has 100 active event definitions.