Custom Events
Custom Events let you create your own tracking events for analysis, and send them through the API.
Custom events table
Shows every custom event you've created.
Each event shows:
Event Label: the event's display name.
Event Key: the unique identifier used in the API.
Description: a short explanation of the event.
Total Property: how many properties the event has.
In the Action column, you can:
Edit the event to update its label, key or properties.
Delete the event completely.
If an event has properties, expand it to see them.
Creating a custom event
Click Create custom events to create a new event.
At the start of the form, fill in:
Event Label: the name shown on your dashboard or analytics.
Event Key: a unique identifier using only lowercase letters and underscores (for example:
order_completed).Description (optional): a short explanation of what the event is for.
The Event Key must be unique, so it doesn't clash with other events or default events.
Custom event properties
Each custom event can have up to 10 properties.
Properties carry extra data when the event is sent through the API.
For each property, fill in:
Property Label: the display name (for example: Order Value, User Type).
Property Key: a unique identifier (lowercase and underscores, for example:
order_value).Property Type: the data type you need:
String
Number
Timestamp
Date
Boolean
Description: an optional explanation of what the property is for.
Click Add custom property to add another property (up to 10).
The order of properties doesn't affect how the event works, but keeping them in order makes them easier to read.
Sending custom events through the API
You can send (fire) custom events through the API using the event key and properties you defined.
Make sure the event key in your API payload matches the Event Key you created exactly.
Every property you send through the API must match its:
Property Key
Property Type