Skip to main content

Integrations, API keys and embedding

The console's Integrations page has three parts. Integrators should read the Integration section; this page is about the decisions administrators make.

Connected systems​

Integrated platforms - learning systems, course sites, intranets - that launch people into this workspace's activities.

  • A system that registered itself through the public API waits here as Awaiting approval. It can do nothing until approved: no launches, no webhooks, no outcomes. Review and approve shows exactly what you are trusting - its issuer, its key set (JWKS), its webhook or that it pulls its outcomes, and its instructor roles. Approve only a registration you were expecting: whoever holds the private keys behind that key set can launch people into the activities you link.
  • Reject removes the registration; the audit log keeps a record of what it claimed to be. The system could register again with the same key unless you revoke the key.
  • Approving and rejecting need the owner or admin role, and both are recorded in the audit log.

Creating an integration directly, linking resources, disabling and rotating its signing secret are done through the workspace API; see Registration and linking.

API keys​

Owners mint keys for scripts and integrations. Choose the narrowest scopes that work: a key carries its own scopes rather than its creator's role, and keeps them if its creator leaves. The secret is shown once. Revoke keys you no longer need; revoked keys stay listed so you can still answer "what had access last March". See REST API.

To let a platform register itself, mint a key with the integrations:register scope (and outcomes:read if it will pull outcomes) and hand it over. One key registers one integration.

Webhooks​

Owners register HTTPS endpoints and can read each endpoint's delivery log. See Webhooks.

Which sites may embed sessions​

Sessions can be embedded on other web pages, but only on pages whose origin the deployment allows. That list is set by the deployment's operator for the whole deployment, not per workspace, and is empty by default. To embed sessions on your intranet or course site, ask the operator to add its origin. See Embedding a session.