Engage Platform
Technical reference for the Engage platform.
For guidance on creating Engage projects in the CMS, see Using Engage.
Detailed technical documentation for Engage is coming soon.
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
| Feature | Engage | Meet | Activate |
|---|---|---|---|
| Structure | Levels with branches | Linear timeline | Simple levels |
| Team support | No | Yes | No |
| Branching | Yes | No | No |
| Leaderboard | No | Yes | No |
| Score persistence | Session | Database | Session |
| Best for | Self-paced courses | Live events | Quick activities |
