Skip to main content
Sitecore Documentation
  • Learn
  • Downloads
  • Changelog
  • Roadmap
PersonalizeCloud Portal
Sitecore Personalize developer documentation
  • Developing with Sitecore Personalize
  1. Sitecore Engage SDK reference
  1. Sitecore Personalize developer documentation
  2. Stream API

Functions

This section describes Engage SDK functions.

PurposeFunction
Initialize the Engage SDKClient-side:

  • Engage.init(settings)


Server-side:

  • Engage.initServer(settings)
  • Engage.initServer.handleCookie(req, res)
Send events and orders to Sitecore PersonalizeClient-side tracking:

  • Engage.pageView(eventData[, extensionData])
  • Engage.identity(eventData[, extensionData])
  • Engage.event(type, eventData[, extensionData])


Server-side tracking:

  • EngageServer.pageView(eventData, req[, extensionData])
  • EngageServer.identity(eventData, req[, extensionData])
  • EngageServer.event(type, eventData, req[, extensionData])
Interact with the event queue
  • Engage.addToEventQueue(type, eventData[, extensionData])
  • Engage.processEventQueue()
  • Engage.clearEventQueue()
Run personalizationClient-side tracking:

  • Engage.personalize(personalizationData[, timeout])
  • window.Engage.triggerExperiences()


Server-side tracking:

  • EngageServer.personalize(personalizationData, callback[, timeout])
Work with the browser ID, guest reference, and point of sale
  • Engage.getBrowserId()
  • Engage.getGuestId()
  • Engage.updatePointOfSale(pointOfSale)
If you have suggestions for improving this article, let us know!

Documentation Assistant

This assistant uses AI to generate responses based on Sitecore documentation. While it has access to official sources, answers may be incomplete or inaccurate and should not be considered official advice or support.
Powered by
k
kapa.ai
Protected by reCAPTCHA

© Copyright 2026, Sitecore A/S or a Sitecore affiliated company.
All rights reserved.

Privacy policySitecore Trust CenterTerms of use