How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Sitecore CDP Stream API

The Sitecore CDP Stream API enables applications to send real-time behavioral and transactional events about users to the Sitecore Customer Data Platform. It is designed for high-throughput event ingestion from web, mobile, and server-side applications, capturing interactions such as page views, product views, and purchases. Events sent through the Stream API update guest profiles in near real-time, powering personalization and segmentation use cases.

Sitecore CDP Stream API is one of 33 APIs that Sitecore publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Behavioral Data, Customer Data Platform, Event Tracking, and Real-Time. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

This event API exposes 1 operation across 1 channel, and defines 15 schemas. It is described by AsyncAPI 2.6.0, at version 2.1.

The API connects through 4 servers: https://api-engage-eu.sitecorecloud.io (https), https://api-engage-us.sitecorecloud.io (https), https://api-engage-ap.sitecorecloud.io (https), https://api-engage-jpe.sitecorecloud.io (https).

1 operations 1 channels 15 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
2.1
Base URL
https://api-engage-us.sitecorecloud.io
Resource Areas
1

Channels & Operations 1

Across 1 channel, the API surfaces 1 operation. Each is listed below with its action, channel, parameters, and response codes.

Channels 1
PUB
/v1.2/event/create.json
Send a behavioral or transactional event
sendEvent body

Messages & Schemas 15

The contract defines 15 schemas that model the data carried by its messages. The most detailed are BaseEventPayload (9 properties), OrderItem (5 properties), ProductReference (4 properties). Each schema is shown below with its type and property counts.

ViewEvent
message
Captures a guest's page view interaction
IdentityEvent
message
Associates a guest profile with identifying information
OrderCheckoutEvent
message
Records a completed purchase transaction
AddEvent
message
Records a product being added to the shopping cart
SearchEvent
message
Records a search query performed by the guest
CustomEvent
message
Records a custom application-defined event
BaseEventPayload
object
Base fields shared by all Sitecore CDP Stream API events
9 properties 6 required
ViewEventPayload
object
IdentityEventPayload
object
OrderCheckoutEventPayload
object
AddEventPayload
object
SearchEventPayload
object
CustomEventPayload
object
OrderItem
object
A product line item within an order checkout event
5 properties 3 required
ProductReference
object
A reference to a product in a behavioral event
4 properties 1 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

sitecore-cdp-stream-api-asyncapi.yml Raw ↑

Other APIs Sitecore publishes across the network.

Sitecore XM Cloud GraphQL Delivery API
Sitecore XM Cloud Authoring and Management GraphQL API
Sitecore CDP Batch API
Sitecore Content Hub Admin API
sitecore Audit API
sitecore Authentication API
sitecore Buyers API
sitecore Collections API
sitecore Connections API
sitecore Decision Models API
sitecore Download Orders API
sitecore Entities API
Where this information came from

This is an independent, third-party profile of Sitecore CDP Stream API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.