Skip to main content
Evalingo has an open API, so any applicant tracking system or internal tool that can make an HTTP request can send assessments and receive results. A typical integration is three steps:
1

Create an assessment

POST /v1/assessments with the candidate’s email, the skills to test and the language. You get back the candidate’s link to send from your own system.
2

Wait for the webhook

When the candidate finishes and the result is ready, we post it to the webhook URL you set under Settings → API & Webhooks.
3

Read the result

The webhook carries the CEFR level for each skill. GET /v1/assessments/{id} returns the same at any time.

API overview

The shape of an integration, in a few minutes of reading.

API reference

Every endpoint, field and error code.

​
Before you start

  • API access needs Starter or above, or a free trial. Basic does not include the API or webhooks.
  • Create a key under Settings → API & Webhooks. It is shown once, when you create it. You can have several keys at once and revoke each separately, which lets you rotate a key without downtime.
  • Test assessments are free. Send "test": true to run the whole candidate flow and webhook for real with a synthetic score and no credit used. Add testLevel to get a particular CEFR level back, so you can check how your system handles a weak and a strong candidate.

​
Things worth knowing

  • Assessments created through the API are not emailed to the candidate. Your ATS sends the link, so candidates hear from one place.
  • Choose which questions to use with promptSetId. See question libraries.
  • Retries are safe. Send an Idempotency-Key header when creating an assessment, and a retried request will not create a duplicate.