Configure universal behavior events for mobile apps

Mobile app – Installed

Xtify actionType: Installed

Event Type Code: 89

Attribute name	Data type	Definition
mobileUserId	Short Text	Assigned to the user. 16 alphanumeric characters
channelId	Short Text	Assigned to a specific installation of the application. 8 alphanumeric characters
appKey	Short Text	Mobile application key. 10 alphanumeric characters
channel	Short Text	The channel that caused the UB. 'push'
attribution	Short Text	Not populated.

Mobile app – Uninstalled

Xtify actionType: Uninstalled

Event Type Code: 90

Attribute name	Data type	Definition
mobileUserId	Short Text	Assigned to the user. 16 alphanumeric characters
channelId	Short Text	Assigned to a specific installation of the application. 8 alphanumeric characters
appKey	Short Text	Mobile application key. 10 alphanumeric characters
attribution	Short Text	Not populated

Mobile app – Started a Session

Xtify actionType: sessionStart

Event Type Code: 91

Attribute name	Data type	Definition
mobileUserId	Short Text	Assigned to the user. 16 alphanumeric characters
channelId	Short Text	Assigned to a specific installation of the application. 8 alphanumeric characters
appKey	Short Text	Mobile application key. 10 alphanumeric characters
channel	Short Text	The channel that caused the UB. 'push'
attribution	Short Text	campaignName specified at the time of the push (triggered the UB).

Note: This event is not enabled by default. Contact support if you would like to enable it for your organization.

Mobile app – Ended a session

Xtify actionType: sessionEnd

Event Type Code: 92

Attribute name	Data type	Definition
mobileUserId	Short Text	Assigned to the user. 16 alphanumeric characters
channelId	Short Text	Assigned to a specific installation of the application. 8 alphanumeric characters
attribution	Short Text	Not populated.
appKey	Short Text	Mobile application key. 10 alphanumeric characters
sessionLength	Numeric	Session length in minutes, e.g. '15'.

Note: This event is not enabled by default. Contact support if you would like to enable it for your organization.

Mobile app – Performed a custom event

Xtify actionType: Custom <developerDefined>

Event Type Code: 95

Attribute Name	Data Type	Definition
mobileUserId	Short Text	Assigned to the user. 16 alphanumeric characters
channelId	Short Text	Assigned to a specific installation of the application. 8 alphanumeric characters
attribution	Short Text	Not populated.
appKey	Short Text	Mobile application key. 10 alphanumeric characters
pushType	Short Text	This is either 'simple', 'in-app', or 'inbox' push types
actionTaken	Short Text	'dial', 'app', 'url', 'inbox' or 'read', depending on how the user interacted with the notification they viewed.
customData1	Short Text	Undefined> Reserved for Customer use
customData2	Short Text	Undefined. Reserved for Customer use
customData2	Short Text	Undefined. Reserved for Customer use
otherCustomData	Long Text	Undefined> Reserved for Customer use

Moblie app – Opened a push notification

Xtify actionType: click

Event Type Code: 94

Attribute name	Data type	Definition
mobileUserId	Short Text	Assigned to the user. 16 alphanumeric characters
channelId	Short Text	Assigned to a specific installation of the application. 8 alphanumeric characters
attribution	Short Text	campaignName specified at the time of the push (triggered the UB).
appKey	Short Text	Mobile application key. 10 alphanumeric characters
pushType	Short Text	This is either 'simple', 'in-app', or 'inbox' push types
actionTaken	Short Text	'dial', 'app', 'url', 'inbox' or 'read', depending on how the user interacted with the notification they viewed.
richContentId	Short Text	When users interact with mobile app messages that contain inbox messages or in-app messages, 'richContentId' indicates which piece of content that message contained.
actionValue	Short text	When a user takes an action on a notification, like clicking a URL or opening the phone dialer, 'actionValue' indicates which URL or phone number was involved.

Mobile app – Been sent a push notification

Xtify actionType: sent (server initiated UB)

Event Type Code: 93

Attribute Name	Data Type	Definition
mobileUserId	Short Text	Assigned to the user. 16 alphanumeric characters
channelId	Short Text	Assigned to a specific installation of the application. 8 alphanumeric characters
attribution	Short Text	campaignName specified at the time of the push (triggered the UB).
appKey	Short Text	Mobile application key. 10 alphanumeric characters
pushType	Short Text	One of the following: 'simple', 'inbox', 'inApp', or any other data/extension types. Simple with Inbox (Two UB events) pushType = 'simple', extensions = ['inbox'] pushType = 'inbox', extensions = [] Simple with extensions 'watch' and 'car' (Three UB events) pushType = 'simple', extensions = ['watch','car'] pushType = 'watch', extensions = [] pushType = 'car', extensions = [] Simple with Inbox and extensions 'watch' and 'my extension type' (Four UB events) pushType = 'simple', extensions = ['inbox','watch','my extension type'] pushType = 'inbox', extensions = [] pushType = 'watch', extensions = [] pushType = 'my extension type', extensions = []
Extension	Array of elements	Indicates which extensions (if any) were included in the push that went out. pushType= 'simple', extensions array is not empty and includes all extensions used in the push, e.g. 'inbox', 'watch', 'car', etc. pushType = extension type, and extension array is empty.

Mobile app – Enabled push notifications

Xtify actionType: ?

Event Type Code: 103

Attribute name	Data type	Definition
mobileUserId	Short Text	Assigned to the user. 16 alphanumeric characters
channelId	Short Text	Assigned to a specific installation of the application. 8 alphanumeric characters
attribution	Short Text	Not populated.
appKey	Short Text	Mobile application key. 10 alphanumeric characters
channel	Short Text	The channel that cause the UB. "push"

Mobile app – Disabled push notifications

Xtify actionType:

Event Type Code: 104

Attribute Name	Data Type	Definition
mobileUserId	Short Text	Assigned to the user. 16 alphanumeric characters
channelId	Short Text	Assigned to a specific installation of the application. 8 alphanumeric characters
appKey	Short Text	Mobile application key. 10 alphanumeric characters
channel	Short Text	The channel that caused the UB. 'push'
attribution	Short Text	Not populated.

Location – Dwelled in a beacon area

Event type code: 160

Attribute name	Data type	Definition	Operators
appKey	Short Text	Mobile application key 10 alphanumeric characters	Is equal to Contains Contains one of the following
channelId	Short Text	Assigned to a specific installation of the application. 8 alphanumeric characters	Is equal to Contains Contains one of the following
locationCity	Short Text	City attribute for the parent site that contains the geofence entity.	Is equal to Contains Contains one of the following
locationState	Short Text	State attribute for the parent site that contains the geofence entity.	Is equal to Contains Contains one of the following
locationCountry	Short Text	Country attribute for the parent site that contains the geofence entity.	Is equal to Contains Contains one of the following
postalCode	Short Text	Postal Code attribute for the parent site that contains the geofence entity.	Is equal to Contains Contains one of the following
locationRegion	Short Text	Region where the geofence belongs.	Is equal to Contains Contains one of the following
siteGroupIds	Long Text	Group IDs	Not used in 17.1 release
siteId	Short text	Site ID of the (immediate) parent site of the geofence entity that was breached.	Is equal to Contains Contains one of the following
locationAttributeIds	Long Text	Concatenated long string of all the arbitrary attributeIds aggregated (unique) attributes in the tree.	Contains Contains one of the following

Note: This event is not enabled by default. Contact support if you would like to enable it for your organization.

Location – Exited a beacon area

Event type code: 159

By default, location exited events are disabled for all organizations. To enable these events for your organization, contact Support.

Attribute name	Data type	Definition	Operators
appKey	Short Text	Mobile application key 10 alphanumeric characters	Is equal to Contains Contains one of the following
channelId	Short Text	Assigned to a specific installation of the application 8 alphanumeric characters	Is equal to Contains Contains one of the following
locationCity	Short Text	City attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationState	Short Text	State attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationCountry	Short Text	Country attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
postalCode	Short Text	Postal Code attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationRegion	Short Text	Region where the geofence belongs	Is equal to Contains Contains one of the following
siteGroupIds	Long Text	Group IDs	Not used in 16.4 release
siteId	Short text	Site ID of the (immediate) parent site of the geofence entity that was breached	Is equal to Contains Contains one of the following
locationAttributeIds	Long Text	Concatenated long string of all the arbitrary attributeIds aggregated (unique) attributes in the tree	Contains Contains one of the following

Note: This event is not enabled by default. Contact support if you would like to enable it for your organization.

Location – Dwelled in a geofence

Event Type Code: 114

Attribute Name	Data Type	Definition	Operators
appKey	Short Text	Mobile application key 10 alphanumeric characters	Is equal to Contains Contains one of the following
channelId	Short Text	Assigned to a specific installation of the application 8 alphanumeric characters	Is equal to Contains Contains one of the following
locationCity	Short Text	City attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationState	Short Text	State attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationCountry	Short Text	Country attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
postalCode	Short Text	Postal Code attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationRegion	Short Text	Region where the geofence belongs	Is equal to Contains Contains one of the following
locationRadius	Numeric	Radius of the geofence entity that triggered the event on the device	Is equal to Is less than Is greater than Is between Is equal to one of the following
siteGroupIds	Long Text	Group IDs	Not used in 16.4 release
siteId	Short text	Site ID of the (immediate) parent site of the geofence entity that was breached.	Is equal to Contains Contains one of the following
locationAttributeIds	Long Text	Concatenated long string of all the arbitrary attributeIds aggregated (unique) attributes in the tree.	Contains Contains one of the following

Note: This event is not enabled by default. Contact support if you would like to enable it for your organization.

Location – Entered a beacon area

Event Type Code: 158

Attribute Name	Data Type	Definition	Operators
appKey	Short Text	Mobile application key 10 alphanumeric characters	Is equal to Contains Contains one of the following
channelId	Short Text	Assigned to a specific installation of the application 8 alphanumeric characters	Is equal to Contains Contains one of the following
locationCity	Short Text	City attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationState	Short Text	State attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationCountry	Short Text	Country attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
postalCode	Short Text	Postal Code attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationRegion	Short Text	Region where the geofence belongs	Is equal to Contains Contains one of the following
siteGroupIds	Long Text	Group IDs	Not used in 17.1 release
siteId	Short text	Site ID of the (immediate) parent site of the geofence entity that was breached.	Is equal to Contains Contains one of the following
locationAttributeIds	Long Text	Concatenated long string of all the arbitrary attributeIds aggregated (unique) attributes in the tree	Contains Contains one of the following

Note: This event is enabled by default.

Location – Entered a geofence

Attribute Name	Data Type	Definition	Operators
appKey	Short Text	Mobile application key 10 alphanumeric characters	Is equal to Contains Contains one of the following
channelId	Short Text	Assigned to a specific installation of the application 8 alphanumeric characters	Is equal to Contains Contains one of the following
locationCity	Short Text	City attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationState	Short Text	State attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationCountry	Short Text	Country attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
postalCode	Short Text	Postal Code attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationRegion	Short Text	Region where the geofence belongs	Is equal to Contains Contains one of the following
locationRadius	Numeric	Radius of the geofence entity that triggered the event on the device	Is equal to Is less than Is greater than Is between Is equal to one of the following
siteGroupIds	Long Text	Group IDs	Not used in 16.4 release
siteId	Short text	Site ID of the (immediate) parent site of the geofence entity that was breached.	Is equal to Contains Contains one of the following
locationAttributeIds	Long Text	Concatenated long string of all the arbitrary attributeIds aggregated (unique) attributes in the tree.	Contains Contains one of the following

Note: This event is enabled by default.

Location – Exited a geofence

Event Type Code: 113

By default, Location exited events are disabled for all organizations. To enable these events for your organization, contact Support.

Attribute Name	Data Type	Definition	Operators
appKey	Short Text	Mobile application key 10 alphanumeric characters	Is equal to Contains Contains one of the following
channelId	Short Text	Assigned to a specific installation of the application 8 alphanumeric characters	Is equal to Contains Contains one of the following
locationCity	Short Text	City attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationState	Short Text	State attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationCountry	Short Text	Country attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
postalCode	Short Text	Postal Code attribute for the parent site that contains the geofence entity	Is equal to Contains Contains one of the following
locationRegion	Short Text	Region where the geofence belongs	Is equal to Contains Contains one of the following
locationRadius	Numeric	Radius of the geofence entity that triggered the event on the device	Is equal to Is less than Is greater than Is between Is equal to one of the following
siteGroupIds	Long Text	Group IDs	Not used in 16.4 release
siteId	Short text	Site ID of the (immediate) parent site of the geofence entity that was breached.	Is equal to Contains Contains one of the following
locationAttributeIds	Long Text	Concatenated long string of all the arbitrary attributeIds aggregated (unique) attributes in the tree.	Contains Contains one of the following

Note: This event is not enabled by default. Contact support if you would like to enable it for your organization.

Universal behavior events

Mobile app – Installed

Mobile app – Uninstalled

Mobile app – Started a Session

Mobile app – Ended a session

Mobile app – Performed a custom event

Moblie app – Opened a push notification

Mobile app – Been sent a push notification

Mobile app – Enabled push notifications

Mobile app – Disabled push notifications

Location – Dwelled in a beacon area

Location – Exited a beacon area

Location – Dwelled in a geofence

Location – Entered a beacon area

Location – Entered a geofence

Location – Exited a geofence

Comments

Universal behavior events

Mobile app – Installed

Mobile app – Uninstalled

Mobile app – Started a Session

Mobile app – Ended a session

Mobile app – Performed a custom event

Moblie app – Opened a push notification

Mobile app – Been sent a push notification

Mobile app – Enabled push notifications

Mobile app – Disabled push notifications

Location – Dwelled in a beacon area

Location – Exited a beacon area

Location – Dwelled in a geofence

Location – Entered a beacon area

Location – Entered a geofence

Location – Exited a geofence

Related articles