Getting Started
- What is TestInvite?
- Build Your First Test
- Run Your First Assessment
- Taking the Assessment
- Viewing the Results
- Question Bank Overview
- Common Question Features
- Scoring
- Question Types
- Question Authoring
- Browsing Questions
- Content Blocks
- Media Library
- Metadata Rules & Schema
- Roles & Access
- Tests Overview
- My Tests
- Creating a Test
- The Test Editor
- Test Settings
- Sections & Pages
- Adding Questions
- Page Builders
- Test Profile
- Reporting
- Test Papers
- Analytics
- Publishing a Test
- Test Library
- Marketplace
- Tasks Overview
- Creating a Task
- Task Dashboard
- Steps
- Task Settings
- Candidates
- Test Sessions
- Sent Mails
- Proctoring
- Analytics
- Analytics Overview
- Test Analytics
- Question Analytics
- Per-Question Analytics
- Results Explorer
- Segment Analysis
Integrations
REST API Reference
Integration Workflow
The typical end-to-end integration: create a candidate, get them into the task, and learn how their session went — usually just two round trips per candidate.
Published 2026/08/26
Most integrations follow the same shape, and it usually takes only two calls per candidate:
- Your app calls Create Candidate for the task the person should take.
- TestInvite creates the candidate and returns their
invitationCodeanddirectAccessUrl. - Your app shares access with the candidate — either the direct access URL yourself, or let TestInvite send it by email (see below).
- The candidate follows the link, and a test session begins the moment they start a step.
- When the session completes, TestInvite posts the result back to your app if you provided a callback — see Webhooks & Callbacks — or your app can fetch it on demand using the candidate ID or your own tracking ID.
Skip Sharing Links Yourself: Auto-Invite by Email
Pass inviteByEmail: { emailTemplateName, dateToSend? } on Create, and TestInvite sends the invitation directly — no need to email the access link yourself. The named template must exist on the task (see Email Templates) and contain a placeholder for the access link.
Querying Results On Demand
If you'd rather poll than rely on a callback, use the candidate ID from the Create response — or your own externalId, if you set one — to look up their test sessions with List or Search on Test Sessions & Results.