arrow_back Embeddables
Collection Player Hub and above
The Collection Player plays a structured collection of courses in sequence. Reach for it when a single course isn't enough and the learning has a natural progression to it. The example below plays a sample collection so you can see what the full experience looks like in context.
It suits multi-week onboarding programmes, certification tracks, and tiered training paths that move recipients from basics to advanced. The collection holds the structure so you don't have to stitch courses together yourself. If the learning is a journey rather than a single stop, this is the embeddable for it.
API Endpoint
POST
/v1/headless/embed/collectionBody parameters
| Field | Type | Example | Description | Demo Value |
|---|---|---|---|---|
action | string | view | — | — |
collectionId | number | 456 | — | — |
identifier | string | your-user-id | — | — |
clientIdentifier | string | your-tenant-id | — | — |
name | string | Jane Doe | — | — |
avatar | string | https://example.com/avatar.jpg | — | — |
navigate | nativeeventnone | "native" | Controls how course clicks behave in the collection player. | |
options.language | string | — | ISO language code for the collection. If translation is not available, the player will default to the collection's default language. |
Emitted Events
How to listen to events| Type | Event | Description | Notes |
|---|---|---|---|
session | ready | Fires when the collection player is mounted and ready. | |
navigation | open | Fires when a course is clicked with navigate set to "event". | Payload includes url, embeddable, id, and action. |
course | start | Fires when a course within the collection is started. | |
course | progress | Fires when course progress changes. | Progress only ever increases. |
course | completed | Fires when a course is completed. |