Skip to content

API and webhooks

Put conversation practice into your own product.

Everything you can do in the dashboard for delivering practice is also available through a documented REST API. Your platform stays the place where users live. Practice runs in the background and results come back to you.

What you can do with the API

  • Grant access

    Give a user access to a scenario or a training product when they buy a course, join a cohort or reach a step in your onboarding.

  • Start sessions

    Create a session for a specific user and scenario and receive a link or a token for the embedded player.

  • Read results

    Fetch session status, scores and report summaries to show them in your own interface or store them next to your course data.

Webhooks instead of polling

Subscribe to events such as session started, session ended and report.completed, plus assignment and access changes. Each delivery is signed and timestamped so you can verify it came from us, and you can send a test event before going live. Payloads carry identifiers and summaries. Hidden scenario content is never included.

Made for developers

  • Test and live keys

    Build against test mode without touching real participants. Keys are scoped, so an integration gets only the permissions it needs.

  • Safe retries

    Write requests accept an idempotency key, so a network retry does not create a second session or a duplicate grant.

  • OpenAPI and a TypeScript SDK

    The API is described in an OpenAPI document. A typed TypeScript SDK covers the common flows and is tested against the same contract.

Product

Connect practice to your stack

Read the docs, create a test key and run your first session from code.