Here are the different data models you can receive after enabling ATS assessments webhooks.
Candidate Assessment
Model ID: ats_candidate_assessment
| Name | Type | Description |
|---|---|---|
id | String | Unique identifier for the candidate assessment record |
assessmentPackage | AssessmentPackage | Please refer to Assessment Package Model |
candidate | Candidate | Please refer to Candidate Model |
applicationId | String | Unique identifier for the associated application in the ATS system |
jobId | String | Unique identifier for the job position associated with this assessment |
status | String | Current status of the assessment. One of: STARTED, IN_PROGRESS, COMPLETED, REJECTED, EXPIRED, PENDING, CANCELLED, NOT_SPECIFIED or specified as in the Native App |
callbackUrl | String | URL where assessment results or updates should be sent |
originData | JsonObject | Raw data received from the source ATS system containing raw assessment information |
metaData | JsonObject | Additional metadata associated with the assessment |
Assessment Package
Model ID: ats_assessment_package
| Name | Type | Description |
|---|---|---|
id | String | Unique identifier for the assessment package |
name | String | Name of the assessment package (e.g., "Frontend Engineer Assessment") |
description | String | Description of what the assessment package entails |
type | String | Type of assessment (e.g., SKILLS_TEST, CODING_CHALLENGE, PERSONALITY) |
metaData | JsonObject | Additional metadata associated with the assessment package |
Candidate
Model ID: candidate
| Name | Type | Description |
|---|---|---|
id | String | Unique identifier for the candidate in the ATS system |
firstName | String | Candidate's first name |
lastName | String | Candidate's last name |
phones | List[Phone] | Please refer to Phone Model |
emails | List[Email] | Please refer to Email Model |
links | List[String] | List of links such as LinkedIn, portfolio, or personal website |
location | String | Candidate's location (city, state, or full address) |
Event Data Example
{
"candidateAssessment": {
"id": "ats_ass_a1b2c3d4e5f6g7h8i9j0k",
"assessmentPackage": {
"id": "pkg_456",
"name": "Frontend Engineer Assessment",
"description": "Technical Skills Assessment",
"type": "SKILLS_TEST",
"metaData": {}
},
"candidate": {
"id": "cand_789xyz",
"firstName": "Alex",
"lastName": "Chen",
"phones": [
{
"type": "WORK",
"phoneNumber": "+1 (555) 123-4567"
},
{
"type": "PERSONAL",
"phoneNumber": "+1 (555) 987-6543"
}
],
"emails": [
{
"type": "PRIMARY",
"email": "[email protected]"
},
{
"type": "WORK",
"email": "[email protected]"
}
],
"links": [
"https://linkedin.com/in/alexchenexample",
"https://github.com/alexchenexample"
],
"location": "San Francisco, CA"
},
"applicationId": "app_123abc",
"jobId": "job_456def",
"status": "STARTED",
"callbackUrl": "https://example.ats.com/callback/ats-assessments",
"originData": {},
"metaData": {
"property1": "value1"
}
}
}
