Event object

Custom events

The event object for a custom event must include all the required attributes for event objects. Set the value of the type attribute to a custom event name of your choice. The custom event name must be different than Sitecore CDP reserved event names.

You can add custom attributes of your choice.

Example

This example describes an event object for a custom event in an integration that uses the Boxever JavaScript Library. The browser_id is set to the value that the Boxever.getID() function returns.

In the type attribute of the event, the custom event name is specified as myretailsite:CLICKED_POPUP. The event contains the custom attributes clickedPopup and timeBetweenPopupAndClick.

const customEvent = {
    browser_id: Boxever.getID(),
    channel: "WEB",
    type: "myretailsite:CLICKED_POPUP",
    language: "EN",
    currency: "EUR",
    page: "home",
    pos: myretailsite/ireland,
    clickedPopup: isPopupClicked(), // true or false
    timeBetweenPopupAndClick: `${getTimestampPopup() - getTimestampClick()} ${timeUnit}` // for example, "8 seconds"
};

If you have suggestions for improving this article, let us know!