Status update pushed to your update-url
Your endpointRefapp sends this request to your system. Nothing here is called by you.
Sent to partner-result.update-url with the static bearer token you gave Refapp at provisioning. The host must be on the allow-list agreed with Refapp. Sent when the candidate is created, on every state change and on completion. Answer with any 2xx.
Body
application/json, required
-
typestringrequiredAlways"partner-results" -
idstringrequired -
attributesobjectrequiredShow properties
-
statusstringrequiredOne of"sending","sent","pending","completed","failed" -
summarystringrequired -
urlstring -
candidateLinkobjectShow properties
-
urlstringrequired -
descriptionstringrequired -
typestringOne of"report-url","report-pdf-data","candidate-url"
-
-
candidateSubmissionPageLinkobjectShow properties
-
urlstringrequired -
descriptionstringrequired -
typestringOne of"report-url","report-pdf-data","candidate-url"
-
-
assessmentobjectShow properties
-
typestringAlways"reference-check" -
scorenumber -
totalnumber -
remainingToSubmitnumber -
completednumber -
declinednumber -
fraudWarningsarray of string
-
-
attachmentsarray of objectShow item properties
-
urlstringrequired -
descriptionstringrequired -
typestringOne of"report-url","report-pdf-data","candidate-url"
-
-
criteriaobjectValues to route the candidate on, keyed by criterion id.
moving_criteriainGET /webhooks/ats-generic/configis the source of truth for the criteria and values that this account receives. This reference shows only the criteria and values that exist today. A criterion is left out until it has a value. Criteria and values can be added or removed at any time. Refapp avoids breaking changes, so a new criterion or value is more likely than a removed one or a changed value type. Ignore ids and values that you do not know.Show properties
-
background_check_outcomestringWhere the background check stands.
anomalies_*once it found anomalies: pending until a reviewer approves or rejects them.declinedwhen the candidate declined. More values can be added.One of"in_progress","clear","anomalies_pending_review","anomalies_approved","anomalies_rejected","declined" -
reference_check_fraudstringwarningwhile a fraud warning is active on the candidate. More values can be added.One of"positive","warning" -
reference_check_referees_overduestringoverdueonce the deadline for adding referees has passed and the candidate has not added all requested referees. More values can be added.One of"overdue","not_overdue" -
reference_check_behavioursstringwarningwhen a behavioural trait fell outside the target range,insufficientwhen too few referees answered to compare against the benchmark. More values can be added.One of"positive","warning","insufficient" -
reference_check_cwbstringwarningwhen a referee reported a counterproductive work behaviour. More values can be added.One of"positive","warning" -
reference_check_recommendationnumberHow strongly the referees recommend the candidate, in percent.
minimum: 0·maximum: 100 -
(any other key)string | number
-
-
detailsobjectText in the account's language to show to a recruiter. The keys are names and labels, which can change. Routing rules must use
criteria, notdetails.Show properties
-
(any other key)string | objectShow alternatives
-
Alternative 1string -
Alternative 2objectShow properties
-
(any other key)string
-
-
-
-
What to answer
Received.