Event Properties
Event properties capture user interactions and activities within your application. Unlike user properties (which describe who users are), event properties describe what users do. This documentation outlines how to structure and use event properties effectively.
Core Event Structure
Each event in the system follows this data model:
Property | Type | Required | Description |
---|---|---|---|
contact_id | String | Yes | A unique user identifier |
timestamp | Timestamp | Yes | When the event happened in UTC |
event_name | String | Yes | Name corresponding to the triggered event |
event_instance_id | String | No | Unique identifier for this specific event instance |
metadata | JSON | No | Additional contextual data about the event |
Common Event Types
Navigation Events
Events that track how users move through your application:
-
page_viewed
- Metadata:
page_name
: Name of the page (e.g., "homepage", "product_detail")page_url
: Full URL of the pagereferrer_url
: Where the user came fromsession_id
: Current session identifier
- Metadata:
-
feature_accessed
- Metadata:
feature_name
: Name of accessed feature (e.g., "search", "filters")feature_location
: Where in the app the feature appears
- Metadata:
Transaction Events
Events that track commerce and financial activities:
-
product_viewed
- Metadata:
product_id
: Unique product identifierproduct_name
: Name of the productproduct_category
: Category of the productproduct_price
: Current pricecurrency
: Currency code (e.g., "USD")
- Metadata:
-
product_added_to_cart
- Metadata:
product_id
: Product identifierquantity
: Number of items addedvariant_id
: Product variant (if applicable)cart_id
: Current cart identifiercart_value
: New total cart value
- Metadata:
-
checkout_started
- Metadata:
cart_id
: Cart identifiercart_value
: Total valueitem_count
: Number of itemscoupon_code
: Applied discount code (if any)
- Metadata:
-
order_completed
- Metadata:
order_id
: Unique order identifierorder_value
: Total value of orderpayment_method
: Method used (e.g., "credit_card", "paypal")shipping_method
: Chosen shipping optionproducts
: Array of purchased product IDsquantities
: Array of quantities (corresponding to products)
- Metadata:
Messaging Events
Events that track communication and notification activities:
-
message_sent
- Metadata:
message_id
: Unique identifier for the messagemessage_type
: Type of message (e.g., "text", "email", "push")recipient_id
: ID of the recipienttemplate_id
: If using a template, the template identifiercampaign_id
: Associated marketing campaign (if applicable)
- Metadata:
-
message_delivered
- Metadata:
message_id
: Message identifierdelivery_timestamp
: When message was delivereddelivery_status
: Status (e.g., "delivered", "failed")
- Metadata:
-
message_opened
- Metadata:
message_id
: Message identifieropen_timestamp
: When message was openeddevice_type
: Device used to open (e.g., "mobile", "desktop")
- Metadata:
-
message_clicked
- Metadata:
message_id
: Message identifierlink_id
: Identifier for the specific linklink_url
: Target URLclick_timestamp
: When click occurred
- Metadata:
Engagement Events
Events that track how users interact with content:
-
content_viewed
- Metadata:
content_id
: Content identifiercontent_type
: Type of content (e.g., "article", "video")category
: Content categoryduration
: Time spent viewing (seconds)
- Metadata:
-
video_played
- Metadata:
video_id
: Video identifiervideo_title
: Video titleduration
: Length of video in secondsplay_position
: Starting position in secondsquality
: Selected video quality
- Metadata:
Account Events
Events tracking user account activities:
-
user_registered
- Metadata:
registration_method
: How they signed up (e.g., "email", "google")referral_source
: Where they came frominitial_plan
: Selected plan (if applicable)
- Metadata:
-
user_logged_in
- Metadata:
login_method
: Authentication method useddevice_type
: Type of device usedapp_version
: Application version
- Metadata:
Industry-Specific Events
E-commerce Events
-
product_searched
- Metadata:
search_term
: User's search queryfilter_applied
: Any filters usedresults_count
: Number of resultscategory_context
: Category being searched
- Metadata:
-
wishlist_updated
- Metadata:
product_id
: Product identifieraction
: "added" or "removed"wishlist_count
: New total count
- Metadata:
-
review_submitted
- Metadata:
product_id
: Product identifierrating
: Numerical rating (e.g., 1-5)review_length
: Character count of reviewhas_media
: Contains photos/videos (boolean)
- Metadata:
Gaming Events
-
game_started
- Metadata:
game_mode
: Selected modemap_id
: Game environmentcharacter_id
: Selected character/classdifficulty
: Game difficulty
- Metadata:
-
level_completed
- Metadata:
level_id
: Level identifierscore
: Achieved scoretime_taken
: Completion time in secondsattempts
: Number of attemptsstars_earned
: Achievement rating
- Metadata:
-
in_app_purchase
- Metadata:
item_id
: Purchased item identifieritem_type
: Type of virtual itemprice
: Cost in real currencycurrency
: Currency codepurchase_location
: Where in game purchase was made
- Metadata:
Food Delivery Events
-
restaurant_searched
- Metadata:
search_term
: Search keywordscuisine_filter
: Any cuisine filters appliedlocation
: Search locationresults_count
: Number of results
- Metadata:
-
menu_item_viewed
- Metadata:
restaurant_id
: Restaurant identifieritem_id
: Menu item identifieritem_category
: Food categoryitem_price
: Pricedietary_tags
: Array of applicable dietary tags
- Metadata:
-
delivery_status_changed
- Metadata:
order_id
: Order identifiernew_status
: Current status (e.g., "preparing", "out_for_delivery")estimated_arrival
: Updated ETAdriver_id
: Delivery person identifier
- Metadata:
Updated about 1 month ago