Collection Card Build and above
The Collection Card is a single tile that previews a collection and opens it in place. Use it when you want to feature a whole series of courses rather than an individual course. The example below features a sample collection, with the card opening the full view of courses inline when clicked.
It's useful for highlighting a flagship onboarding journey, a certification track, or a curated bundle of courses on a homepage, dashboard, or content hub. It does the same job as the Course Card, but the unit being promoted is the full course collection.
Give the host <iframe> a descriptive title so recipients can identify the embedded content.
API Endpoint
/v1/headless/embed/collection/cardBody parameters
| Field | Type | Example | Description | Demo Value |
|---|---|---|---|---|
action | viewedit | view | Determines the target action when the card is clicked. | |
collectionId | number | 456 | — | — |
identifier | string | your-user-id | — | — |
clientIdentifier | string | your-tenant-id | — | — |
navigate | nativeeventnone | "native" | Controls card click behaviour. | |
options.fill | boolean | true | When true, the card fills the iframe. Otherwise, the card is centered at intrinsic size. | |
options.language | string | — | Set options.language to the BCP-47 language code used by the card frame (for example, fr or en-AU). | |
options.expiresIn | string | 3h | Link opening lifetime, "30s" to "3h" (e.g. "5m"). Invalid values return 400. Course links opened from inside keep 3h. |
Navigation events require the API authoring add-on. With events unavailable, navigate: 'event' opens the item's URL using native navigation. Use navigate: 'none' for a non-interactive card.
Emitted Events
How to listen to events| Type | Event | Description | Notes |
|---|---|---|---|
navigation | open | Fires when the card is clicked with navigate set to "event". | Payload includes url, embeddable, id, and action. |