Event object
The Boxever JavaScript Library is no longer receiving updates.
We recommend that you upgrade to the Sitecore Engage SDK to get future updates and enhancements.
If you integrate with Sitecore Personalize using the Boxever JavaScript Library or direct HTTP requests, use this event object to collect all the event data about a user's interaction with your application. You then send the event to Sitecore Personalize.
Required attributes
At a minimum, every event data object must include the following attributes. Note that event data objects for different event types may require more attributes than listed in this table.
|
Attribute |
Type |
Description |
Example |
|---|---|---|---|
|
|
string |
The browser ID. If you are using the Boxever JavaScript Library, set the value to the value that the If you are using direct HTTP requests, set the value to the value that was returned when you retrieved the browser ID. |
The browser ID is a string similar to:
|
|
|
string (uppercase) |
The touchpoint where the user interacts with your brand. For example, for webpages, the channel is |
Must be one of:
|
|
|
string (uppercase) |
The type of the event that takes place when the user interacts with your brand. To send a Sitecore Personalize standard event, for example, VIEW or IDENTITY, set the value to a Sitecore Personalize reserved event name. To send a custom event, set the value to a custom event name of your choice. The custom event name must be different than Sitecore Personalize reserved event names. Sitecore Personalize reserved event names: |
|
|
|
string (uppercase ISO 639-1) |
The language the user is using your app in. For example, if the user selects the Japanese language on your website, the language is |
|
|
|
string (uppercase ISO 4217) |
The alphabetic currency code of the currency the user is using in your app. For example, if the user selects Australian dollars as the currency on your website, the currency is |
|
|
|
string |
The name of the webpage where the interaction with your brand takes place. This is a custom value of your choice. |
|
|
|
string |
The name of the point of sale where the interaction with your brand takes place. You must set this value to the name of a point of sale that exists in your instance of Sitecore Personalize. |
|