arrow_back Embeddables
Course Player Pulse and above
The Course Player surfaces a single Coassemble course inside your product. Reach for it when recipients should get the full learning experience without leaving your environment. The example below plays a sample course so you can see what the full experience looks like in context.
The course player is a fit for product onboarding flows that walk a new user through a guided course, in-app training modules, customer education programmes, and anywhere a complete course is the right unit of content. If sending users out to a separate learning site would break the moment, this is the embeddable that keeps them with you.
API Endpoint
POST
/v1/headless/embed/courseBody parameters
| Field | Type | Example | Description | Demo Value |
|---|---|---|---|---|
action | string | view | — | — |
courseId | number | 123 | — | — |
identifier | string | your-user-id | — | — |
clientIdentifier | string | your-tenant-id | — | — |
name | string | Jane Doe | — | — |
avatar | string | https://example.com/avatar.jpg | — | — |
options.language | string | en | ISO language code for the player UI. If translation is not available, the player will default to the course's default language. |
Emitted Events
How to listen to events| Type | Event | Description | Notes |
|---|---|---|---|
session | ready | Fires when the course player is mounted and ready. | |
course | start | Fires when a course is started. | |
course | progress | Fires when course progress changes. | Progress only ever increases. |
course | feedback | Fires when course feedback is selected. | Fires multiple times if selection changes. |
course | completed | Fires when the course is completed. | |
course | generated | Fires when the course is generated by an AI flow. | |
screen | start | Fires when a screen comes into view. | |
screen | end | Fires when a screen is navigated away from. | |
screen | complete | Fires when a screen is completed. | Trigger varies by screen type. |
screen | answer | Fires when a quiz question is answered. | Quiz screens only. |
screen | failed | Fires when a scored quiz screen is failed. | Quiz screens only. |
screen | retry | Fires when a scored quiz screen is retried. | Quiz screens only. |