Integration overview
Murmle integrates with other systems through four published surfaces. None of them is specific to one product: every integrated platform, intranet or script uses the same ones.
| You want to... | Use | Set up by |
|---|---|---|
| Send people from your platform into a Murmle activity, and learn how they did | The integration contract: a signed launch token in, outcome events back | A workspace owner or admin registers your platform |
| Read activities, start and drive sessions, read results and exports from a script | The REST API with a workspace API key | A workspace owner mints the key |
| Be told when something happens | Webhooks, signed with HMAC-SHA256 | A workspace owner registers the endpoint |
| Put a session's participant view inside your own page | Embedding by join code | The deployment's operator allows your page's origin |
Principles that hold across all of them
- The workspace comes from the credential. An API key, an integration and a webhook each belong to exactly one workspace, and no request can name a different one.
- Privacy rules apply unchanged. A script or an integration gets exactly what a person in the console would get, and anonymous sessions stay anonymous through every surface. An outcome naming a learner is only ever produced for an identified session.
- The server decides. Integrations send identities and receive outcomes; they never send a score or a verdict.
- Credentials are shown once. API key secrets, webhook signing secrets and integration signing secrets are returned at creation (or rotation) and never again. Murmle stores them hashed or encrypted.
- No product-specific code paths. Murmle treats every conforming client identically. Pamba is described as a worked example, not a special case.
Where to start
- Building an integration: read the contract overview, then the launch and outcome events.
- Automating Murmle from a script: REST API and the generated API reference.