Read the settings available to your account
https://{host}/webhooks/account-integration/configOptional. Returns the questionnaires, templates and other settings as form fields, for building a settings screen on your side.
Authentication
Authorization: Bearer <token>
The token Refapp issued for your account. It identifies the account, so nothing else is needed.
Query parameters
-
job_idstringYour id for the requisition the settings are for, the same value as
candidate.job.idwhen submitting. -
langstringLanguage for the field labels, as an ISO 639-1 code such as
svoren. -
recruiterstringEmail of the recruiter setting things up, so the options can be limited to what that person may see.
-
webhook_datastringJSON-serialised current field values; send it when re-fetching after a field marked
refetchchanged.
Responses
The form fields to render.
Show response body
-
configobjectrequiredShow properties
-
fieldsarray of objectrequiredThe form fields to render. Treat them as dynamic content: fields can be added or removed at any time. Refapp avoids breaking changes, so a new field is more likely than a removed field or a changed value type.
Show item properties
-
idstringrequired -
typestringrequiredOne of"select","checkbox","text","header","subheader","paragraph" -
labelstringrequired -
valuestring | boolean | number -
placeholderstring -
optionsarray of objectShow item properties
-
idstringrequired -
labelstringrequired
-
-
disabledboolean -
requiredboolean -
refetchbooleanWhen true, fetch the config again with the current values in
webhook_datawhenever this field changes. -
label-markdownstring -
label-htmlstring -
label-classstringOne of"info","warning","error","success","default"
-
-
moving_criteriaarray of objectThe criteria that status updates for this account can carry in
criteria, with a name and labels in the requested language to show a recruiter building routing rules. This list is the source of truth for the criteria and outcomes of the account: build routing rules from it, not from the criteria and values in this reference. Treat the list as dynamic content, likefields: criteria and outcomes can be added or removed at any time, and the list follows the account's settings. Refapp avoids breaking changes, so a new criterion or outcome is more likely than a removed one or a changed value type. The list is left out when the account has no criteria.Show item properties
-
Alternative 1objectWhere the background check stands.
anomalies_*once it found anomalies: pending until a reviewer approves or rejects them.declinedwhen the candidate declined.Show properties
-
idstringrequiredAlways"background_check_outcome" -
namestringrequired -
kindstringrequiredAlways"outcome" -
outcomesarray of objectrequiredminItems: 1Show item properties
-
idstringrequiredOne of"in_progress","clear","anomalies_pending_review","anomalies_approved","anomalies_rejected","declined" -
labelstringrequired -
hintstring
-
-
-
Alternative 2objectwarningwhile a fraud warning is active on the candidate.Show properties
-
idstringrequiredAlways"reference_check_fraud" -
namestringrequired -
kindstringrequiredAlways"outcome" -
outcomesarray of objectrequiredminItems: 1Show item properties
-
idstringrequiredOne of"positive","warning" -
labelstringrequired -
hintstring
-
-
-
Alternative 3objectoverdueonce the deadline for adding referees has passed and the candidate has not added all requested referees.Show properties
-
idstringrequiredAlways"reference_check_referees_overdue" -
namestringrequired -
kindstringrequiredAlways"outcome" -
outcomesarray of objectrequiredminItems: 1Show item properties
-
idstringrequiredOne of"overdue","not_overdue" -
labelstringrequired -
hintstring
-
-
-
Alternative 4objectwarningwhen a behavioural trait fell outside the target range,insufficientwhen too few referees answered to compare against the benchmark.Show properties
-
idstringrequiredAlways"reference_check_behaviours" -
namestringrequired -
kindstringrequiredAlways"outcome" -
outcomesarray of objectrequiredminItems: 1Show item properties
-
idstringrequiredOne of"positive","warning","insufficient" -
labelstringrequired -
hintstring
-
-
-
Alternative 5objectwarningwhen a referee reported a counterproductive work behaviour.Show properties
-
idstringrequiredAlways"reference_check_cwb" -
namestringrequired -
kindstringrequiredAlways"outcome" -
outcomesarray of objectrequiredminItems: 1Show item properties
-
idstringrequiredOne of"positive","warning" -
labelstringrequired -
hintstring
-
-
-
Alternative 6objectHow strongly the referees recommend the candidate, in percent.
Show properties
-
idstringrequiredAlways"reference_check_recommendation" -
namestringrequired -
kindstringrequiredAlways"score" -
rangeobjectrequiredShow properties
-
minnumberrequiredAlways0 -
maxnumberrequiredAlways100
-
-
-
Alternative 7objectA criterion this document does not list yet. Ignore it unless you know its id.
Show alternatives
-
Alternative 1objectShow properties
-
idstringrequired -
namestringrequired -
kindstringrequiredAlways"outcome" -
outcomesarray of objectrequiredminItems: 1Show item properties
-
idstringrequired -
labelstringrequired -
hintstring
-
-
-
Alternative 2objectShow properties
-
idstringrequired -
namestringrequired -
kindstringrequiredAlways"score" -
rangeobjectShow properties
-
minnumberrequired -
maxnumberrequired
-
-
-
-
-
Show example
{
"config": {
"fields": [
{
"id": "string",
"type": "select",
"label": "string",
"value": "string",
"placeholder": "string",
"options": [
{
"id": "string",
"label": "string"
}
],
"disabled": true,
"required": true,
"refetch": true,
"label-markdown": "string",
"label-html": "string",
"label-class": "info"
}
],
"moving_criteria": [
{
"id": "background_check_outcome",
"name": "string",
"kind": "outcome",
"outcomes": [
{
"id": "in_progress",
"label": "string",
"hint": "string"
}
]
}
]
}
}The token is missing, unknown, revoked, or the integration is not enabled for the account. All four look the same.