Create a custom event

Create a custom event (event-schema definition) on an application.

Required scope: setup.custom_events:create

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Public ID of the resource.

Query Params
fields[]
array of strings

Field selection for token economy: an explicit list of field names to include in the response, or ["*"] for every field. Omit for this endpoint's own default field set.

fields[]
Body Params
boolean

Whether the event is active.

category_tag_ids
array of strings

Category tag public IDs (cat_…) to associate with this event.

category_tag_ids
string

Display color (hex) shown in console.

custom_event_properties
array of objects

Properties this event carries — fully replaces the existing set. Each entry is either { id } (an existing property public_id of the application) or { name, data_type, position? } (links the application's property with that name, or declares it; data_type is required and must match). A property is shared by every event of the application: it is renamed, retyped or deleted through the custom event properties endpoints. data_type must be one of: int, bool, float, string, date, array_of_strings.

custom_event_properties
string
required

Display name shown in console.

boolean

Whether the event is tracked.

string
required

Stable machine identifier used in SDK calls (unique within the app).

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json