Once the company has enabled the integration, its box and button will appear in the candidate profile:

Before proceeding, the assessments-specific URLs must be set.

URLs

tests

List of tests available to the customer that can be used to send the assessment to the candidate.

GET {partner.urls.tests} HTTP/1.1
Content-Type: application/json
Authorization: Bearer {token}

Example response:

{
  "tests": [
    {"name": "JavaScript", "id": 1},
    {"name": "Ruby", "id": 2},
    {"name": "PostgreSQL", "id": 3}
  ]
}

This example URL can be used in the initial development phase: https://1da22d5d35232651e170c77e943d5a68.m.pipedream.net

send_assessment

Request that triggers sending an assessment to the candidate.

POST {partner.urls.send_assessment} HTTP/1.1
Content-Type: application/json
Authorization: Bearer {token}

{
  "first_name": "Jon",
  "last_name": "Snow",
  "email": "[email protected]",
  "candidate_id": 1,
  "company_id": 1,
  "report_id": "bb83dc83-91b2-46a5-8a21-824067f29c68",
  "test_id": "2",
  "test_name": "Ruby"
}
  • first_name, last_name, and email belong to the candidate,
  • test_id and test_name come from the selected test,
  • candidate_id, company_id, and report_id are IDs as saved in Recruitee that will be used later to update report's status or URLs.

The report will only be saved if we receive a success status from your API.

🚧

company_id must be saved alongside report_id - both will be needed to update the report's status later. It's the ID of the company the candidate belongs to and will be different for different customers.

This example URL can be used in the initial development phase: https://44c576c0fcabcf04b41673900b795b1b.m.pipedream.net

Sending assessment

Click "Send Best Assessments test", then select a test

Click "Send"

You can see that a badge and report have appeared:

Scroll down to see how to update this report using the report_id you've received.