You can provide a webhook that our platform will POST to with data whenever a candidate joins an assessment. Click Edit webhooks in your API settings on your dashboard to edit the URL.
The data is minimal to notify you simply that a candidate started the assessment.
{
"operation": "candidate_joined",
"organization_id": "coderbyteengineering",
"email": "[email protected]",
"assessment_id": "angular-assessment-9six08om28556"
}
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 theiss
or issuer in the payload.