Event data object
Use the event data object to collect behavioral and transactional data about a user's interaction with your app. You can optionally collect custom data about the event using the extension data object. After you create your event data objects, you can send the events 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 (uppercase) |
The touchpoint where the user interacts with your brand. For example, for webpages, the channel is |
Must be one of:
|
|
|
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 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. If you did not specify If you specified |
|
Optional attributes
An event data object can optionally include the following attributes:
|
Attribute |
Type |
Description |
Example |
|---|---|---|---|
|
|
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 This is a custom value of your choice. For client-side events, the default value is inferred from the HTML For server-side events, the default is an empty string. |
|
|
|
string |
The name of the webpage where the interaction with your brand takes place. This is a custom value of your choice. For client-side events, the default value for the root page of your website is For server-side events, the default is an empty string. |
|