Track events
UpdatedThere's a new version available!
These pages cover version 3 of our SDK, but a newer version is available. In general, we suggest that you update to the latest version to take advantage of new features and fixes.
- Are you new to our SDKs? Check out the latest docs.
- Otherwise, learn about updating to the latest version
Events represent things people do in your app so that you can track your audience’s activity and metrics. Use events to segment your audience, trigger campaigns, and capture usage metrics in your app.
This page is part of a setup flow for the SDK. Before you continue, make sure you've implemented previous features—i.e. you can't send events before you identify people!
Track a custom event
After you identify a person, you can use the track
method to send events representing their activities to Customer.io. When you send events, you can include event data—information about the person or the event that they performed.
In Customer.io, you can use events to trigger campaigns and broadcasts. Those campaigns might send someone a push notification or manipulate information associated with the person in your workspace. You can reference the data in your event to segmentA segment is a group of people in your audience that you want to target with campaigns, messages, etc. You can join groups of people manually, or by attribues and event data. members of your audience or as variables in your messages using liquidA syntax that supports variables, letting you personalize messages for your audience. For example, if you want to reference a person’s first name, you might use the variable {{customer.first_name}}
..
Events include the following:
name
: the name of the event. Most event-based searches in Customer.io hinge on the name, so make sure that you provide an event name that will make sense to other members of your team.attributes
(Optional): The body of the event. You can reference attributes in messages and other campaign actionsA block in a campaign workflow—like a message, delay, or attribute change. using liquidA syntax that supports variables, letting you personalize messages for your audience. For example, if you want to reference a person’s first name, you might use the variable{{customer.first_name}}
. in the format{{event.<attribute>}}
.
CustomerIO.instance().track(
name = "purchase",
attributes = mapOf("product" to "socks", "price" to "4.99")
)
Check out our sample apps!
Screen view events
Screen views are events that record the pages that your audience visits in your app. They have a type
property set to screen
, and a name
representing the title of the screen or page that a person visited in your app.
Screen view events let you trigger campaignsCampaigns are automated workflows that send people messages and perform other actions when people meet certain criteria. or add people to segmentsA group of people who match a series of conditions. People enter and exit the segment automatically when they match or stop matching conditions. based on the parts of your app your audience uses. Screen view events also update your audience’s “Last Visited” attribute, which can help you track how recently people used your app.
Enable automatic screen tracking
When you enable automatic screen tracking, the SDK sends an event every time a person visits a screen in your app. You can turn on automatic screen tracking by appending autoTrackScreenViews(true)
to CustomerIO.Builder
.
When automatically tracking screen events, we capture the name of the screen with the following priority from highest to lowest:
- We check if the current
Activity
has alabel
in the manifest file. If it does, the SDK will use the value forlabel
. - We get the class name of the
Activity
and use that value.
The SDK will take whatever value it receives and will strip the word Activity
from it. Example: If you have an Activity
with the manifest label
or class name ProfileActivity
, the SDK will track the screen view with the name Profile
.
CustomerIO.Builder(
siteId = "your-site-id",
apiKey = "your-api-key",
appContext = this
)
.autoTrackScreenViews(true)
.build()
If you want to send more data with screen events, or you don’t want to send events for every individual screen that people view in your app, you can send screen events manually.
Send your own screen events
Screen events use the .screen
method. Like other events, you can add a map of attributes
object containing additional information about the screen
event or the currently-identified person.
CustomerIO.instance().screen(
name = "baseballDailyScores",
attributes = mapOf("prevScreen" to "homescreen", "secondsInApp" to "120")
)