Skip to main content
Sitecore Documentation
  • Learn
  • Downloads
  • Changelog
  • Roadmap
CDPCloud Portal
Sitecore CDP Developer Documentation
  • Developing with Sitecore CDP
  1. Sitecore CDP Developer Documentation
  1. Sitecore CDP Developer Documentation

Functions

Markdown version

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 CDPClient-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:

  • window.Engage.triggerExperiences()
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!

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

Privacy policySitecore Trust CenterTerms of use
CDPCloud Portal