Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Assessment

assessment.update

Update Ashby about the status of a started assessment.

assessment_status is required unless cancelled_reason is provided.

Requires the candidatesWrite permission.

post/assessment.update

Request body

assessment_idstring required

Identifier of the assessment being updated

timestampnumber required

The timestamp in milliseconds since the unix epoch when the assessment update occurred

Example request

{
  "assessment_id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "timestamp": 1665680638489,
  "assessment_status": {
    "identifier": "result-max",
    "label": "Max Score",
    "description": "The maximum possible score for the assessment"
  },
  "assessment_profile_url": {
    "identifier": "result-max",
    "label": "Max Score",
    "description": "The maximum possible score for the assessment"
  },
  "assessment_result": {
    "identifier": "result-max",
    "label": "Max Score",
    "description": "The maximum possible score for the assessment"
  },
  "cancelled_reason": {
    "identifier": "result-max",
    "label": "Max Score",
    "description": "The maximum possible score for the assessment"
  },
  "metadata": [
    {
      "identifier": "result-max",
      "label": "Max Score",
      "description": "The maximum possible score for the assessment"
    }
  ]
}

Response

Responses from the assessment.update endpoint

OR

Example response

{
  "success": true,
  "results": {
    "assessmentId": "completed-node-assessment"
  }
}