These docs are a work in progress. Some pages may be incomplete or out of date while we continue updating them.

Engage Platform

Technical reference for the Engage platform.


Overview

Engage is a level-based platform for structured learning journeys with branching paths. Key characteristics:

  • Level-based structure — Content organised into discrete levels
  • Branching support — Learner choices can lead to different paths
  • Progress tracking — Track completion across levels
  • Self-paced — Learners progress at their own speed

PostMessage API

Games and screens communicate with Engage using the standard PostMessage API.

Core messages

Engage supports the standard asset messages:

// Mark activity as complete
window.parent.postMessage({ message: "finish" }, "*")

// Update score
window.parent.postMessage({
  message: "updateScore",
  value: 50,
  choice: "option_a"
}, "*")

// Request next page
window.parent.postMessage({
  message: "requestForNextPage",
  score: 50,
  totalGameScore: 150,
  gameId: "quiz-1",
  page: 1
}, "*")

// Reset
window.parent.postMessage({ message: "reset" }, "*")

Comparison with other platforms

FeatureEngageMeetActivate
StructureLevels with branchesLinear timelineSimple levels
Team supportNoYesNo
BranchingYesNoNo
LeaderboardNoYesNo
Score persistenceSessionDatabaseSession
Best forSelf-paced coursesLive eventsQuick activities

Was this page helpful?