The flow
- List tests — fetch the tests published to your institution.
- Assign — create an assignment for one of your users. You get back an
assignmentIdand a signedstartUrl. - Start — your user opens the
startUrl. They’re signed in automatically (no password, no separate registration) and land directly on the test. - Results — you receive webhooks as the student
starts, submits, and is graded — each carrying your
externalUserIdandpartnerAssignmentIdso you can correlate exactly. You can also pollGET /partner/v1/assignments/{id}. - Return — when the student finishes, a “Return to <you>” button
sends them back to the
callbackUrlyou provided.
What you’ll need
An API key
Server-to-server credential, created in the admin portal.
A callback domain
Allowlist the domain your students return to.
Published tests
We curate which of your tests are assignable — ask your Quippy contact.
A webhook endpoint
Recommended, for real-time result delivery.
Conventions
- Base URL:
https://api-sg.quippy-lab.com - All requests and responses are JSON.
- All timestamps are ISO 8601 UTC.
- All IDs are opaque strings — never parse or depend on their format.
- The API is versioned in the path (
/partner/v1/…). New fields and events may be added without a version bump, so parse tolerantly.
This is a server-to-server API. Your API key must never appear in browser
or mobile code — see Authentication.