Docs
arrow_back Embeddables

Collection Builder Build and above

The Collection Builder is the authoring experience for assembling collections of courses, embedded in your product. Use it when your customers need to design their own learning paths or certification tracks. The example below loads a sample collection into the builder so you can see how the structure-building experience looks in context.

It suits academy admins building tiered programmes, partners curating their own journeys, and any scenario where the structure of learning content needs to be authored inside your product. Pair it with the Course Builder when users should be able to both create the course content and shape collections around it.

API Endpoint

POST/v1/headless/embed/collection

Body parameters

FieldTypeExampleDescriptionDemo Value
actionstringedit——
collectionIdnumber456——
identifierstringyour-user-id——
clientIdentifierstringyour-tenant-id——
namestringJane DoeDisplay name for presence avatars and comment authors. Optional. An empty or blank name is treated as not given. When not given, a colour-and-animal name such as Green Turtle is generated from identifier and stays the same for that identifier. Max 512 characters; longer values return HTTP 400 (`name max=512, asked for N`).
avatarstringhttps://example.com/avatar.jpgImage URL for presence avatars and comment authors. Optional. An empty or blank avatar is treated as not given: no avatar is shown, and it does not generate a name. Otherwise it must be an http(s) URL. Max 2048 characters; longer values return HTTP 400 (`avatar max=2048, asked for N`). Other schemes also return 400.
themeIdnumberCustom theme ID to apply to the embeddable.
options.backeventhiddennativeeventBack button behaviour.
options.expiresInstring3hLink opening lifetime, "30s" to "3h" (e.g. "5m"). Invalid values return 400.
TypeEventDescriptionNotes
sessionreadyFires when the collection builder is mounted and ready.
sessionerrorFires when an error occurs.
sessionexpiredFires when the session expires.
back—Fires when the Back button is clicked.

Live Demo