Embed overview

Embed is how you build Coassemble into your own product: a REST API and a set of embeddable components for creating, delivering, and tracking courses inside your own app.

Embed lets you build training into your own product rather than sending people to a separate Coassemble site. You author, deliver, and track courses through the Coassemble API and a set of embeddable components, so course creation and learning happen inside your own interface, under your own brand. What you build runs on the same infrastructure as the rest of Coassemble, so it meets WCAG 2.2 Level AA and runs on SOC 2 Type 2 compliant infrastructure, and clears IT, security, and procurement review.

What you build with

Embed gives you two ways to integrate, and most teams use both together.

• The REST API. Create and manage courses, collections, and screens, generate content, identify learners, read tracking and results, and manage themes, translations, and usage.
• Embeddable components. Drop ready-made pieces into your own pages, loaded in an iframe: course, collection, and screen players for delivery, builder components so your users can author and edit, and analytics components for reporting. They come in view mode (take a course) and edit mode (build a course).

Alongside these, your app can listen for in-page events as a learner moves through a course, and receive server-to-server webhooks when a course is created, started, or completed.

What you can build with it

• Deliver training inside your product. Place a course or collection player in an onboarding flow, a help centre, or a customer portal, so learners take training without leaving your app.
• Let your own users create courses. Combine the builder components with the Generate API so the people using your product can build and edit courses themselves, in your interface.
• Show results in your own dashboard. Use the analytics components, or pull tracking data through the API, to surface course and learner data alongside the rest of your reporting.
• Serve multiple tenants. Scope users and content to your own tenants with a client identifier, so each of your customers sees only their own courses, learners, and branding.

Because the learning runs inside your product, it's served from your own domain automatically, with no separate domain setup in Coassemble.

Where the full developer documentation lives

The complete reference, with endpoints, parameters, and examples, is at developers.coassemble.com. Key sections:

• Get started for authentication and your first request.
• Embeddables, Events, and Webhooks for building the front end and reacting to activity.
• Errors & rate limits for handling responses.
• API references for Courses, Generate, Collections, Identities, Tracking, Themes, Translations, and Usage.

Frequently asked questions

What's the difference between using the API and the embeddables?

The embeddable components are ready-made pieces you load into your pages, which is the fastest way to add a player, builder, or analytics view. The API gives you direct control to build your own experience and to do things the components don't cover, like creating content programmatically or reading raw tracking data. You can use them together: embed a component for the interface, and call the API for the data and content behind it.

Can my users build their own courses inside my product?

Yes. The builder (edit-mode) embeddables and the Generate API let the people using your product author and edit courses without leaving your app.

Can I keep each customer's content and learners separate?

Yes. A client identifier scopes users and content to your own tenants, so each customer sees only their own courses, learners, and branding.

Where do I get API keys?

API keys are created in your Coassemble workspace settings. Authentication details are covered in the Get started guide.