Conventions for events and properties

Goal of this document is to set the rules and format for creating events and their properties.

1. Events

1.1. Style

• all lowercase
• snake_case

Example:

• LIKE_THIS ❌
• LikeThis ❌
• likethis ❌
• like_this ✅

1.2. Name

Note

Event name format:

[verb] + [action]

Where:

• Verb is one of 5:

  • viewed
  • clicked
  • generated
  • loaded
  • completed

Let’s see if we need more later but right now let’s try and restrict to those 5.

• Action: should 1) be explicit and 2) name things as defined here: https://beetroot.atlassian.net/wiki/spaces/ENVOY/pages/5775786030

Examples

• loaded_gift_button
• seen_gift_button
• generated_gift_link

2. Event Properties

2.1. Style

Same as events: lowercase, snakecase

2.2. Types

• props like user_id, partner_name should be string

• prices should be int

• when several value, simply add ‘list’ at the end of the property, and should be a list / array, for example:

  • cta_copy = ‘Buy Episode’ → cta_copy_list = [‘Buy Episode’, ‘Buy Season’]