---
title: "Event data object"
slug: "event-data-object"
abstract: "Describes the event data object in the Sitecore Engage SDK (Sitecore CDP Stream API)."
---
# 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](https://doc.sitecore.com/cdp/en/developers/api/stream-api/sitecore-engage-sdk-reference/objects/extension-data-object.html "Extension data object"). After you create your event data objects, you can send the events to Sitecore CDP.

## 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 |
| --- | --- | --- | --- |
| `channel` | string (uppercase) | The touchpoint where the user interacts with your brand.<br><br>For example, for webpages, the channel is `"WEB"`. For mobile app screens, the channel is `"MOBILE_APP"`. | Must be one of:<br><br><ul><li>`"AIRPORT_KIOSK"`</li><li>`"BRANCH"`</li><li>`"CALL_CENTER"`</li><li>`"EMAIL"`</li><li>`"GDS"`</li><li>`"KIOSK"`</li><li>`"MOBILE_APP"`</li><li>`"MOBILE_WEB"`</li><li>`"SMS"`</li><li>`"OFFLINE"`</li><li>`"OTA"`</li><li>`"OTHER"`</li><li>`"WEB"`</li></ul> |
| `currency` | string (uppercase [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)) | The alphabetic currency code of the currency the user is using in your app.<br><br>For example, if the user selects Australian dollars as the currency on your website, the currency is `"AUD"`. | <ul><li>`"EUR"`</li><li>`"GBP"`</li><li>`"USD"`</li></ul> |
| `pointOfSale` | string | [The name of the point of sale](https://doc.sitecore.com/cdp/en/developers/api/stream-api/sitecore-engage-sdk-reference/objects/collect-required-details.html#UUID-60c4c930-3cfe-e0ad-3b98-69ceff75989f_section-idm1903325950166538) where the interaction with your brand takes place.<br><br>You must set this value to the name of a point of sale that exists in your instance of Sitecore CDP.<br><br>If you did not specify `pointOfSale` in [the settings object](https://doc.sitecore.com/cdp/en/developers/api/stream-api/sitecore-engage-sdk-reference/objects/settings-object.html), you must specify it in every event data object.<br><br>If you specified `pointOfSale` in the settings object, it's optional in event data objects. You can specify it in any event data object to override the original value of `pointOfSale`, previously specified in the settings object, for that specific event. | `"myretailsite/ireland"` |

## Optional attributes

An event data object can optionally include the following attributes:

| Attribute | Type | Description | Example |
| --- | --- | --- | --- |
| `language` | string (uppercase [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)) | The language the user is using your app in.<br><br>For example, if the user selects the Japanese language on your website, the language is `"JA"`.<br><br>This is a custom value of your choice.<br><br>For client-side events, the default value is inferred from the HTML `lang` attribute. If the HTML `lang` attribute is not specified, the default is an empty string.<br><br>For server-side events, the default is an empty string. | <ul><li>`"DE"`</li><li>`"EN"`</li><li>`"FR"`</li></ul> |
| `page` | string | The name of the webpage where the interaction with your brand takes place.<br><br>This is a custom value of your choice.<br><br>For client-side events, the default value for the root page of your website is `Home Page`. For other pages, the default value is inferred from the URL pathname.<br><br>For server-side events, the default is an empty string. | <ul><li>`"Home Page"`</li><li>`"home"`</li><li>`"contact-us.html"`</li></ul> |