Skip to main content
Skip to content

Embed in your product

Yes. With Coassemble Embed you build courses in Coassemble and deliver them inside your own product. You can use ready-made embeddable components loaded in an iframe, work directly against the API to build your own experience, or mix the two. Learners can take courses, and your users can create courses, without leaving your app.

Embed lets you serve Coassemble experiences inside your own product instead of sending people to a separate Coassemble portal. There are two ways to do it, and you don't have to pick just one:

  • Embeddable components for the common cases. Each is requested as a signed embed URL from the Coassemble API and rendered in an iframe in your app.
  • The API directly when you want to build your own interface. You can drive courses, AI generation, collections, identities, tracking, themes and translations through the API and present them however you like.

Most products start with the embeddable components and reach for the API where they want more control. You can combine both in the same integration.

The embeddable components

Embed provides a set of components you can place in your product. You choose which ones you need rather than dropping in a single fixed portal, and you don't have to use all of them:

  • Course Player and Collection Player for learners to view and complete a course or work through a group of courses.
  • Course Builder and Collection Builder for authoring: the course creation and editing tool, and the collection editor, running inside your product.
  • Course, Collection and User Analytics, read-only dashboards for a specific course, collection or user.
  • Course List, Collection List, Course Card and Collection Card for browsing and selecting what to take.

Use one component on its own or combine several.

Building directly on the API

If the pre-built components don't fit what you want, you can use the API on its own. The API covers courses, AI generation, collections, identities, tracking, themes, translations and usage, so you can assemble a fully custom experience or fill gaps around the components you do embed. The choice isn't all-or-nothing: a typical integration might embed the Course Player but pull analytics through the API to show progress in your own dashboards.

Embedding course creation, not just course playing

Embedding isn't limited to learners taking courses. The Course Builder loads the full authoring experience inside your product, so your own customers, partners or admins can build and edit their own courses in your app. You request it the same way as a player, but with the edit action instead of view. It's the component partner enablement tools and platforms use when course creation needs to feel like a native feature of their own product.

The Course Builder gives you control over what's switched on for your users, including the initial creation flow, Google Drive and OneDrive import, AI features, narrations, translations and publish controls.

How it works

For the embeddable components, the flow is the same each time:

  1. Authenticate to the Coassemble API with your workspace API key, which is stored on your server and never exposed in the browser.
  2. Request a signed embed URL for the component you want, passing the action (view for a learner, edit for authoring), the course or collection it applies to, and a stable identifier for the user from your own system. A clientIdentifier can scope the user to a specific tenant, and a themeId applies your branding.
  3. Render the returned signed URL in an iframe in your product. A fresh signed URL is generated per user per page load rather than cached or reused.

If you're building directly on the API, you authenticate with the same workspace API key and call the endpoints you need from your server, then present the results in your own interface.

The embed uses your own user identifier and your theme, so learners see your branding on your domain rather than Coassemble's. They don't sign in to Coassemble or see its interface.

The embed also sends events to your app as things happen, for example when a session is ready, a course is updated, or a learner makes progress or finishes. Your app listens for these events so it can respond and show results inside your product.

Frequently asked questions

Do I have to use all the embeddable components?

No. Use only the components you need, and skip the rest. You can also build directly on the API instead of, or alongside, the components if you want a fully custom interface.

Can I just use the API without the embeddable components?

Yes. The API covers courses, AI generation, collections, identities, tracking, themes, translations and usage, so you can build your own experience and present it however you like.

Can my users create courses inside my product, not just take them?

Yes. The Course Builder and Collection Builder load Coassemble's authoring tools inside your product. You request the embed with the edit action, and your users build and manage courses without leaving your app. The Course Builder is available on Embed Core and above.

Do learners know they're using Coassemble?

No. The embed is identified by your own user identifier and rendered with your theme on your domain, so it appears as part of your product.

What do I need to use Embed?

A paid plan with API access enabled and a workspace API key. Authoring, analytics and SCORM features each need their own entitlement on top of base API access, so endpoints return a 403 if your plan doesn't include them.

Can I see learner progress?

Yes. Through the analytics components, or directly via the tracking API, so you can surface results in your own dashboards.

This article is maintained in our help centre. View the original ↗