ATS Assessments Data Models

Here are the different data models you can receive after enabling ATS assessments webhooks.

Candidate Assessment

Model ID: ats_candidate_assessment

NameTypeDescription
idStringUnique identifier for the candidate assessment record
assessmentPackageAssessmentPackagePlease refer to Assessment Package Model
candidateCandidatePlease refer to Candidate Model
applicationIdStringUnique identifier for the associated application in the ATS system
jobIdStringUnique identifier for the job position associated with this assessment
statusStringCurrent status of the assessment. One of: STARTED, IN_PROGRESS, COMPLETED, REJECTED, EXPIRED, PENDING, CANCELLED, NOT_SPECIFIED or specified as in the Native App
callbackUrlStringURL where assessment results or updates should be sent
originDataJsonObjectRaw data received from the source ATS system containing raw assessment information
metaDataJsonObjectAdditional metadata associated with the assessment

Assessment Package

Model ID: ats_assessment_package

NameTypeDescription
idStringUnique identifier for the assessment package
nameStringName of the assessment package (e.g., "Frontend Engineer Assessment")
descriptionStringDescription of what the assessment package entails
typeStringType of assessment (e.g., SKILLS_TEST, CODING_CHALLENGE, PERSONALITY)
metaDataJsonObjectAdditional metadata associated with the assessment package

Candidate

Model ID: candidate

NameTypeDescription
idStringUnique identifier for the candidate in the ATS system
firstNameStringCandidate's first name
lastNameStringCandidate's last name
phonesList[Phone]Please refer to Phone Model
emailsList[Email]Please refer to Email Model
linksList[String]List of links such as LinkedIn, portfolio, or personal website
locationStringCandidate'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"
    }
  }
}