Integrations

Connect TestInvite to your own systems — the REST API for developers, and Zapier for no-code automation.

01 · Article

Integrations Overview

TestInvite can connect to your own systems in two ways — a REST API for developers, and Zapier for no-code automation — so registering candidates and collecting results doesn't have to be a manual, in-app step.

02 · Article

Core Concepts

The handful of TestInvite concepts every integration touches — Organization, Task, Candidate, Test, and Test Instance — and how they connect to each other.

03 · Article

Enabling the API

Turn on the API, create an access key with only the permissions it needs, and get the authorization token every request will use — all from Organization → Integration/API.

Access Roles Each access key is granted one or more of nine permissions — grant only what an integration actually needs, since every key can be scoped independently.

04 · Article

REST API Reference

The conventions shared by every REST API endpoint — authentication, the basic/detailed response toggle, and how List, Fetch, and Search differ — plus where to find each resource's specific endpoints.

Tasks List, fetch, search, and update Tasks through the REST API — including the beta Update endpoint's field constraints and per-step overrides. Tests List, fetch, and search Tests through the REST API — tests are read-only via this API; author and edit them in the Test editor. Users List, fetch, search, and expand Users through the REST API — teammates and learners across your whole organization, not scoped to a single task. Candidates Create, list, fetch, update, and delete Candidates under a Task through the REST API — the only resource with full write access, since registering candidates is the core integration use case. Test Sessions & Results Read test sessions and their results through the REST API — the richest resource in the API, with score breakdowns by section, dimension, and effect, plus proctoring evidence and answer sub-resources. Proctoring Evidences Fetch the photos, videos, and screen captures recorded during a test session, along with any AI or manual cheating-detection findings attached to each one. Answers Fetch every question a candidate saw in a test session and exactly what they answered — this endpoint is in beta. 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. Webhooks & Callbacks Get notified the moment a candidate finishes, instead of polling for results — set a callback URL when you create the candidate and TestInvite posts the result to it automatically. Errors The REST API uses standard HTTP status codes — 2xx for success, 4xx when the request itself is the problem, 5xx when TestInvite's the problem.

05 · Article

Zapier

Connect TestInvite to thousands of other apps without writing any code — register candidates from a form or spreadsheet, and react the moment a test session completes.