Sending events

The Stream API lets you collect and send behavioral data to Sitecore Personalize in real time. The behavioral data can include a guest's page views, clicks, searches, and identifiers.

Note

To capture data in JavaScript or TypeScript web applications, we recommend that you use the Cloud SDK or the Engage SDK. These SDKs use the Stream API behind the scenes and let you easily capture data in your web app. Use the Cloud SDK if you have a JSS Next.js or JSS Angular application connected to XM Cloud. Use the Engage SDK in other JavaScript applications.

Your organization can send additional, custom data with events and use that data in real-time personalization and decisioning.

To ensure that you can access view the event data in the Sitecore Personalize UI and use the data elsewhere in Sitecore Personalize, including custom data, you must model the event object, and the optional event data extensions and custom events, according to your organization's integration:

If your organization is using the Engage SDK to integrate, follow the schema for modelling the event data object.

To send additional, custom data with the event, follow the schema for extending the event data object.

To send a custom event, follow the schema for modelling the custom event data object.
If your organization is not using the Engage SDK to integrate, follow the schema for modelling the event data object.

To send additional, custom data with the event, follow the schema for extending the event data object.

To send a custom event, follow the schema for modelling the custom event data object.

Do you have some feedback for us?

If you have suggestions for improving this article,