Result Update Webhook

Result Update Webhook
Webhook

Request

Clearspeed sends a POST request to the customer's webhook endpoint when a result is published or updated. Customers must return HTTP 200 to acknowledge receipt.

Bodyapplication/json

project_uuidstring

Example:"XXXXXXXX-ef1f-4d91-a2e2-7b33132b00f1"

callback_typestring

Example:"Result Update"

access_codestring

Example:"7136XXXX59"

interview_ref_numstring

Example:"456XXXX642"

statusstring

Example:"Result Published"

questions_risk_ratingArray of objects

Example:

[
  {
    "sequence": "7",
    "risk_level": "LR",
    "text": "Q7 "
  },
  {
    "sequence": "2",
    "risk_level": "HR",
    "text": "Q2 "
  }
]

overall_evaluationstring

Example:"HR"

is_admissionboolean

Example:false

is_counter_measureboolean

Example:false

is_not_completeboolean

Example:false

participant_languagestring

Example:"English"

summarystring

Result summary label (for example, HR/LR/G/AR/NC)

Example:"AR"

summary_bgcolorstring

Hex color code associated with the summary label

Example:"#28a745"

clearboolean

Whether result is clear

Example:true

timestampstring, (date-time)

POST

result_update

Payload

{
  "project_uuid": "XXXXXXXX-ef1f-4d91-a2e2-7b33132b00f1",
  "callback_type": "Result Update",
  "access_code": "7136XXXX59",
  "interview_ref_num": "456XXXX642",
  "status": "Result Published",
  "questions_risk_rating": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "overall_evaluation": "HR",
  "is_admission": false,
  "is_counter_measure": false,
  "is_not_complete": false,
  "participant_language": "English",
  "summary": "AR",
  "summary_bgcolor": "#dc3545",
  "clear": true
}

Responses

Result received