Event naming conventions

This page covers proper event naming conventions and best practices. By maintaining consistency in your event and attribute taxonomy, you’ll keep your data clean and usable for new and existing users of the Braze platform. This helps avoid issues later, such as triggering a campaign to the wrong audience or generating wrong results after using the wrong event.

Best practices

• Keep your naming convention clear.
• Use consistent casing and formatting of event names.
• Avoid giving events similar names.
• Avoid long event attribute strings, which will be truncated or cut off in the Braze dashboard.

Naming conventions

Use event groups

Use groups to differentiate parts of your product to name events. By categorizing your product into groups, any user can clearly understand what the event is referring to and what it does.

Event naming structure

The most common naming structure is group_noun_action. Events should all be lowercase to avoid casing instrumentation errors and identifying properties.

Properties

Tag one event and then identify differences by using properties. This is helpful for events that are inherently the same but have minor differences, such as channels for a campaign. We can also easily see how users flow through events. Refer to the event properties object for an example and additional context.

Examples

Let’s say you’re part of an eCommerce company and interested in tracking when customers have signed up for your app and when they have subscribed to your newsletter. Here are examples of effective event names:

• user_signup
• newsletter_sunscribed

These two event names clearly indicate the event they’re tracking. As you create more custom events, be sure to keep your naming conventions understandable. For example, avoid using event names such as signup_event_1 as that lacks clarity and doesn’t convey what the event is tracking, compared to user_signup.