APIs & webhooks

One API. The entire platform.

Q: Does Synap have an API?

Yes. Synap provides a comprehensive REST API at api.synap.ac/v3, built on the JSON:API standard with a published OpenAPI schema. You can read the API documentation to get started.

Q: How much of the platform can I control through the API?

All of it. Synap's interface is built on the same public API, so anything you can do in the product — creating questions and exams, enrolling candidates, delivering assessments, marking, and retrieving results and certificates — can be done programmatically.

Q: How is the API authenticated and secured?

The API uses Personal Access Tokens sent as bearer tokens. Every request is authenticated and authorised on zero-trust principles, with per-token and per-IP rate limiting, schema validation, TLS encryption and audit logging.

Q: Can we control what an API token can access?

Yes. A token is tied to a user and a single portal, so it inherits that user's role-based permissions and can only ever reach data within its portal or sub-portal. Tokens can be revoked at any time and their usage is tracked.

Q: What webhooks does Synap support?

Synap emits 25+ real-time events across the assessment lifecycle, including exam.complete, attempt.submitted, user.registered, attemptCertificate.generated and store.purchase. Deliveries are queued with automatic retries, and you can inspect and re-send them.

Q: Can we connect Synap to AI tools or LLMs?

Yes. Our documentation is published as an MCP server, and the API itself is described by an OpenAPI schema, so AI assistants like Claude can read and operate the API directly — always within the permissions of the access token they use.

Q: Do we need developers to integrate with Synap?

Not necessarily. Many workflows can be built with no code using Zapier, LTI 1.3 and Single Sign-On. For fully custom integrations our REST API gives your developers complete control, and our Professional Services team can build the integration for you.

Q: Which plans include API and webhook access?

The v3 API and webhooks are available on our Business and Enterprise plans, with a dedicated staging environment available for Enterprise. See pricing or talk to us about the right plan for your integration.

Synap runs on a single, fully documented REST API — the same one this product is built on. If your team can do something in the interface, they can automate, integrate and audit it programmatically.

Book a technical walkthrough Read the API docs

REST & OpenAPI
Real-time webhooks
MCP-ready

api.synap.ac/v3

GET /v3/attempts/a1B2c3
Authorization: Bearer p:••••••••

200 OK
{
  "data": {
    "type": "attempts",
    "id": "a1B2c3",
    "attributes": {
      "status": "complete",
      "score": 84,
      "passed": true,
      "submittedAt": "2026-07-11T09:24Z"
    }
  }
}

Trusted by professional organisations, awarding bodies, and universities worldwide

No bolt-on, no blind spots

The same API that powers Synap

Most platforms expose a thin export API, bolted on after the fact — a fraction of what the product can actually do. Synap is different. The interface your team uses, and this very website, are built on the same public v3 API. Its coverage is complete by design.

Complete by construction
Every screen in Synap is powered by a documented endpoint. There is no private, more-capable internal API — what we build with is what you build with.
Nothing held back
Users, question banks, exams, attempts, marking, results, certificates, portals and analytics are all first-class resources you can read and write.
Proven in production
The same endpoints serve millions of assessments and the Synap product itself, so you integrate against battle-tested, production infrastructure.

Everything speaks to the same endpoints

Synap interface

Your integrations

AI agents

Synap v3 API

One public, documented surface

Your assessment platform

Capabilities

What you can build on

A modern REST API designed to run the full assessment lifecycle from your own systems.

Complete platform coverage
Users, groups, questions, exams, attempts, marking sessions, results, certificates, portals and analytics — every object in Synap is an API resource.
Built on open standards
A REST API following the JSON:API standard, with a published OpenAPI schema your engineers and tooling can generate typed clients from.
Run Synap headless
Drive the entire lifecycle from your own systems — create content, enrol candidates, deliver exams and pull results without anyone signing in.
Real-time webhooks
Subscribe to platform events and receive them the moment they happen, instead of polling for changes.
Enterprise access control
Every token is scoped to a portal and inherits a user's role, so integrations get exactly the access they need and no more.
Versioned & stable
A versioned API with a documented, validated schema, so the integrations you build keep working.

Built to integrate

280+
Resources in the public API
25+
Real-time webhook events
JSON:API
Open, documented standard
99.9%
Uptime SLA

Webhooks

Know the moment something happens

Subscribe your systems to Synap events and we push them to your endpoint in real time — no polling, no delays. Select an event to see the payload we send.

Exams & attempts

Candidates & users

Results & certification

Commerce & organisation

A candidate has finished an exam.

POSThttps://your-endpoint.example.com/synap

{
  "event": "exam.complete",
  "occurredAt": "2026-07-11T09:24:11Z",
  "data": {
    "type": "attempts",
    "id": "a1B2c3",
    "attributes": {
      "exam": "Membership Final",
      "user": "u_88213",
      "score": 84,
      "passed": true
    }
  }
}

Durable delivery

Every event is queued and delivered reliably, with automatic retries and back-off if your endpoint is briefly unavailable.

Full delivery visibility

Inspect the status of every delivery — sent, retrying or failed — and re-send any event from the platform.

Authenticated & per-portal

Subscriptions are scoped to a portal and can authenticate to your endpoint, so events reach the right systems securely.

AI-native

Let AI do the heavy lifting

Your team already uses AI assistants. Because Synap's entire API is public, self-describing and published as an MCP server, those assistants can operate the platform directly — no integration project required.

Ask, in plain English, for the work you would otherwise click through by hand. Every action runs inside the permissions you grant.

synap.ac/docs/api

API reference / Attempts

Get an attempt

Ask a question ▾ Open in Claude Open in ChatGPT Open in Cursor

MCP https://synap.ac/docs/~gitbook/mcpCopy

Our docs are hosted on GitBook, so this sits on every page — open it in an assistant, or connect the MCP server directly. No setup on your side.

Author content

"Draft 200 single-best-answer questions on cardiology and add them to the Finals bank."

Analyse results

"Which topics did the March cohort score lowest on? Summarise it for the board."

Run operations

"Enrol these 500 candidates and schedule their exam for Monday at 9am."

Connect in minutes

Point any MCP-compatible assistant at our documentation and it can navigate every endpoint — there is no custom wrapper to build.

A copilot for your whole team

Let non-technical staff query results, build reports or draft questions in natural language, backed by live platform data.

Safe by the same rules

Assistants authenticate with scoped access tokens, so they can only ever do what their assigned role and portal allow.

Security & access

Built on zero-trust principles

Every request is authenticated and authorised — nothing is trusted by default. Access is granted narrowly and revocably, so integrating with Synap never widens your attack surface.

Personal Access Tokens
Authenticate with revocable bearer tokens. Every request is verified independently; nothing is trusted implicitly.
Role-based access
A token acts as a user, inheriting that user's role and permissions — so you grant an integration only the access it needs.
Portal & sub-portal scoping
Every token is bound to a single portal, so an integration can never reach data elsewhere in your organisation.
Rate limiting
Per-token and per-IP rate limits protect the platform, and your data, from misuse or runaway jobs.
Schema-validated requests
Every request and response is checked against the published OpenAPI schema before it touches your data.
Audit logs
Token usage and administrative actions are recorded, so you can always see who did what, and when.
Encrypted end to end
TLS 1.2+ in transit and AES-256 at rest — the same protection applied across the whole platform.
Learn more
You own your data
Everything the API returns is yours. Synap claims no ownership of your content or candidate data.
Learn more

For full detail on hosting, certifications and compliance, see our security and data page. Security & compliance

Alternative ways to integrate

Rather not touch the API?

The API is the most powerful route, but not the only one. Automate visually with no code, or hand the whole thing to our team.

Prefer no code? Automate visually

Connect Synap to Segment, Zapier and 8,000+ apps, embed exams in your LMS over LTI 1.3, and enable Single Sign-On — all without writing a line of code.

Explore integrations

Prefer we build it? Professional Services

Our team can design and implement your integration for you — from candidate enrolment and results sync to full migrations and custom development. You get the outcome without tying up your engineers.

Talk to our team

Integrations & security review

Planning an integration or a technical review?

Bring your developers, your IT team, or both. We'll walk through the API, webhooks, access model and security posture, and map them to your systems.

Book a technical walkthrough Read the API docs

FAQs

API and webhook questions, answered

Find quick answers or browse our academy .

Does Synap have an API?

How much of the platform can I control through the API?

How is the API authenticated and secured?

Can we control what an API token can access?

What webhooks does Synap support?

Can we connect Synap to AI tools or LLMs?

Do we need developers to integrate with Synap?

Which plans include API and webhook access?

Can't find your answer?

Previous feature Integrations

Connect Synap to your LMS, CRM and tools with Zapier, LTI 1.3 and SSO.

Next feature Security & data

ISO 27001, GDPR, encryption, hosting and full data ownership.

Build on the platform that runs on its own API

Book a technical walkthrough, or send your developers straight to the docs.

Book a technical walkthrough Read the API docs

Certified & independently rated

One API. The entire platform.

The same API that powers Synap

Complete by construction

Nothing held back

Proven in production

What you can build on

Complete platform coverage

Built on open standards

Run Synap headless

Real-time webhooks

Enterprise access control

Versioned & stable

Know the moment something happens

Exams & attempts

Candidates & users

Results & certification

Commerce & organisation

Durable delivery

Full delivery visibility

Authenticated & per-portal

Let AI do the heavy lifting

Get an attempt

Connect in minutes

A copilot for your whole team

Safe by the same rules

Built on zero-trust principles

Personal Access Tokens

Role-based access

Portal & sub-portal scoping

Rate limiting

Schema-validated requests

Audit logs

Encrypted end to end

You own your data

Rather not touch the API?

Prefer no code? Automate visually

Prefer we build it? Professional Services

Planning an integration or a technical review?

API and webhook questions, answered

Build on the platform that runs on its own API