Note
All events include Session Properties, Device Properties, App Properties, and Shopify Properties that are present on the Event Object. For more information, refer to the Common Event Object & Metadata document.
Event Properties, however, are unique to every event and are outlined in this page.
The Session Started event indicates the beginning of a new user session. This can occur when the app is opened or when the app is re-engaged following a session timeout.
Note: A session timeout occurs after 30 minutes of inactivity
Multiple events can occur during a session and will all be tied to the session_id
. If a session times out, then a new Session Started event will fire with a new session_id
.
The event properties unique to a Session Started event include:
"event_properties":{
"source":"direct",
"event_id":"UNIQUE SESSION ID",
"session_id":"UNIQUE SESSION ID",
"session_source":"direct",
"session_type":"Returning",
"session_start_time":1692140759000,
"notification_id":null,
"notification_type":null,
"segment_id":null,
}
source
String: A value or parameter tracking where the session originated from. This value is stamped on all events of a session. The default is "direct"
event_id
String : The unique identifier of the session associated with the event. This event will also exist on the Event object level as well.
session_id
String: The unique identifier of every user session in the app
session_source
String: The source in which a session begins. This will be either Direct (an organic source), Notification, or a type of Deep link
Note: To view all the various sources, reference the Event Sources page
session_type
String: The type of session that indicates if this is a returning or first time user. This will be "new" or "returning"
session_start_time
Integer: The recorded start time of a session
notification_id
String: The unique identifier of the notification that lead to the session (if applicable). If a source of the session is "notification" then this field will be
notification_type
String: Distinguishes the various types of push notification campaigns sent. These can occur from the dashboard or even an automated push campaign
segment_id
String : The unique identifier of an automated push campaign. These campaigns would distinguish between welcome campaigns, abandoned cart messages, and any other automations enabled