Save back data to Recruitee with test results.

🚧
Note report.subtitle and report.properties are not available for Background Check and Reference Check partner kinds.

Status

`sent`

Default status for the newly created report.

`completed`

Update the report with the status completed to indicate that the candidate has taken the test.

PATCH https://integrations.rc.recruitee.dev/api/p/{codename}/reports/{report_id} HTTP/1.1
Content-Type: application/json
RT-PARTNER-SECRET: {partner.secret}

{
  "status": "completed"
}

`failed`

Update the report with the status failed to indicate that the candidate has taken and failed the test.

PATCH https://integrations.rc.recruitee.dev/api/p/{codename}/reports/{report_id} HTTP/1.1
Content-Type: application/json
RT-PARTNER-SECRET: {partner.secret}

{
  "status": "failed"
}

`canceled`

Update the report with the status canceled to indicate that the test has been canceled.

PATCH https://integrations.rc.recruitee.dev/api/p/{codename}/reports/{report_id} HTTP/1.1
Content-Type: application/json
RT-PARTNER-SECRET: {partner.secret}

{
  "status": "canceled"
}

You can also set the report.urls.cancel URL and allow the user to cancel the test from Recruitee.

Score

report.score is a text field and can be set to any value closely matching your score in your system, e.g. a number, fraction, percentage, or a short description.

Number

PATCH https://integrations.rc.recruitee.dev/api/p/{codename}/reports/{report_id} HTTP/1.1
Content-Type: application/json
RT-PARTNER-SECRET: {partner.secret}

{
  "score": "10",
  "status": "completed",
  "completed_at": "2022-10-06T18:22:26.927622Z"
}

Percentage

PATCH https://integrations.rc.recruitee.dev/api/p/{codename}/reports/{report_id} HTTP/1.1
Content-Type: application/json
RT-PARTNER-SECRET: {partner.secret}

{
	"score": "76%"
}

Fraction

PATCH https://integrations.rc.recruitee.dev/api/p/{codename}/reports/{report_id} HTTP/1.1
Content-Type: application/json
RT-PARTNER-SECRET: {partner.secret}

{
	"score": "12/15"
}

Text

Scores longer than 5 characters will not fit in the badge and the status icon will be shown in the interface instead.

PATCH https://integrations.rc.recruitee.dev/api/p/{codename}/reports/{report_id} HTTP/1.1
Content-Type: application/json
RT-PARTNER-SECRET: {partner.secret}

{
	"score": "Astonishing"
}

URLs

`open`

Non-API URL. Will show the "Open" button next to the report and will open a new browser tab for the customer with this URL.

`download_pdf`

API URL not directly visible to the customer. Will be called with the authorization token.

GET {report.urls.download_pdf} HTTP/1.1
Content-Type: application/json | application/pdf
Authorization: Bearer {token}

The response can take one of two forms. You can respond with a simple JSON string with a valid URL. URL that's being returned can expire, or be a single-use only. Example response:

"https://www.newcastle.edu.au/__data/assets/pdf_file/0008/333773/LD-Report-Writing-LH.pdf"

You can also send a full PDF binary the user will be able to download, as long as you set the Content-Type header to application/pdf.

These example URLs can be used in the initial development phase:

`cancel_invitation`

API URL not directly visible to the customer. Will be called with the authorization token.

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

A successful 200 response will change the report's status to canceled.
The button to cancel the invitation will be shown only for reports in the status sent.

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