Skip to main content
Users
CloudPortalLogin
  • Powered byPowered by
Developing with Sitecore Personalize
Data privacy
Before you start sending data
Integrating with Sitecore Personalize
Stream API
Personalize API Flow execution
REST APIs
  • Sitecore Personalize for developers
  • Stream API
  • Sitecore Engage SDK reference
  • Functions

Functions

This section describes Engage SDK functions.

Purpose

Function

Initialize the Engage SDK

Client-side:

  • Engage.init(settings)

Server-side:

  • Engage.initServer(settings)

  • Engage.initServer.handleCookie(req, res)

Send events and orders to Sitecore Personalize

Client-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 personalization

Client-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)

Do you have some feedback for us?

If you have suggestions for improving this article,

Privacy policySitecore Trust CenterCopyright © 1999-2025 Sitecore