Base Event Structure

At a high level, all Komo Events are structured as follows:

{
  "eventName": "page-view", // the event name
  "eventData": {
    // ... the event payload
  },
  "extensionData": {
    // ... the optional extension data
  },
  "trackedData": {
    // ... the optional admin-defined contact properties
  }
}

Base Event Payload Data

All Komo Event eventData payloads include the following fields, providing context about the webpage, host, and browser.

Name	Type	Description	Required
timestamp	`String (TimeStamp)`	The timestamp of the event	Required
pageTitle	`String`	The title of the page where the event occurred	Required
hostName	`String`	The hostname of the page where the event occurred	Required
pathName	`String`	The path of the page where the event occurred	Required
queryString	`String`	The query string of the page where the event occurred	Required
url	`String`	The URL of the page where the event occurred	Required
referrer	`String`	The URL that linked to the page where the event occurred	Required
languages	`Array`	The languages of the browser that made the request	Required
userAgent	`String`	The user agent of the browser that made the request	Required

Standard Event Fields

Depending on the Event category, the following fields are always included.

Hub Events

All events raised on hub pages (including individual cards and embedded card pages) and surveys will include these fields.
Coupon events do not include these fields.

Name	Type	Description	Required
siteId	`String (GUID)`	The ID of the hub where the event occurred	Required
siteName	`String`	The name of the hub where the event occurred	Required
userId	`String (GUID)`	The ID of the user that performed the action	Required
contactId	`String (GUID)`	The ID of the contact that performed the action	Required

Card Events

All events raised from cards will include these fields.

Name	Type	Description	Required
siteId	`String (GUID)`	The ID of the hub where the event occurred	Required
siteName	`String`	The name of the hub where the event occurred	Required
userId	`String (GUID)`	The ID of the user that performed the action	Required
contactId	`String (GUID)`	The ID of the contact that performed the action	Required
pageId	`String (GUID)`	The ID of the page where the event occurred	Optional
pageSlug	`String`	The slug of the page where the event occurred	Optional
cardId	`String (GUID)`	The ID of the card	Required
cardType	`String`	The type of the card	Required
cardSubType	`String`	The sub-type of the card	Required
cardName	`String`	The name of the card	Required

Survey Events

All events raised from surveys will include these fields.

Name	Type	Description	Required
siteId	`String (GUID)`	The ID of the hub where the event occurred	Required
siteName	`String`	The name of the hub where the event occurred	Required
userId	`String (GUID)`	The ID of the user that performed the action	Required
contactId	`String (GUID)`	The ID of the contact that performed the action	Required
surveyId	`String (GUID)`	The ID of the survey that the form field is on	Required
surveyName	`String`	The name of the survey that the form field is on	Required
recipientId	`String (GUID)`	The ID of the survey recipient that touched the form field	Required

Tracked Data

Events may optionally include trackedData containing admin-defined contact properties.
These properties are configured by site administrators and automatically resolved from user data when events are emitted.
This data is used for analytics tracking in systems like GTM and Adobe Launch.
For detailed information, see Tracked Data (Advanced).