API Reference

You can provide a webhook that our platform will POST to with data whenever an interview is completed.

Click Edit webhooks in your API settings on your dashboard to edit the URL.

The data is minimal to notify you simply that an interview is finished, so to receive the full report you'll need to hit the Interview report data route.

{
  "operation": "interview_completed",
  "organization_id": "coderbyteengineering",
  "email": "[email protected]",
  "report_url": "https://coderbyte.com/report/interview:w246Ri1UP:coderbyteengineering",
  "interview_id": "w246Ri1UP"
}

📘

Authentication

To verify the request is coming from Coderbyte, we provide a Bearer authentication token as a JWT. You can verify the token is correct by generating a JWT and signing it with HS256. Use your API key as the signing key and your organization_id as the iss or issuer in the payload.