RefappRefapp

Read the settings available to your account, with the parameters in the body

View as Markdown
POSThttps://{host}/webhooks/account-integration/config

The same as GET, with the query parameters in a JSON body instead. Use it when webhook_data makes the URL too long.

Authentication

Authorization: Bearer <token>

The token Refapp issued for your account. It identifies the account, so nothing else is needed.

Body

application/json, required

  • job_idstring | number

    Your id for the requisition the settings are for, the same value as candidate.job.id when submitting.

  • langstring

    Language for the field labels, as an ISO 639-1 code such as sv or en.

  • recruiterstring

    Email of the recruiter setting things up, so the options can be limited to what that person may see.

  • webhook_dataobject

    Current field values as an object keyed by field id; send it when re-fetching after a field marked refetch changed.

    Show properties
    • (any other key)string | boolean | number

Responses

200application/json

The form fields to render.

Show response body
  • configobjectrequired
    Show properties
    • fieldsarray of objectrequired

      The 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
      • typestringrequired
        One of "select", "checkbox", "text", "header", "subheader", "paragraph"
      • labelstringrequired
      • valuestring | boolean | number
      • placeholderstring
      • optionsarray of object
        Show item properties
        • idstringrequired
        • labelstringrequired
      • disabledboolean
      • requiredboolean
      • refetchboolean

        When true, fetch the config again with the current values in webhook_data whenever this field changes.

      • label-markdownstring
      • label-htmlstring
      • label-classstring
        One of "info", "warning", "error", "success", "default"
    • moving_criteriaarray of object

      The 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, like fields: 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 1object

        Where the background check stands. anomalies_* once it found anomalies: pending until a reviewer approves or rejects them. declined when the candidate declined.

        Show properties
        • idstringrequired
          Always "background_check_outcome"
        • namestringrequired
        • kindstringrequired
          Always "outcome"
        • outcomesarray of objectrequired
          minItems: 1
          Show item properties
          • idstringrequired
            One of "in_progress", "clear", "anomalies_pending_review", "anomalies_approved", "anomalies_rejected", "declined"
          • labelstringrequired
          • hintstring
      • Alternative 2object

        warning while a fraud warning is active on the candidate.

        Show properties
        • idstringrequired
          Always "reference_check_fraud"
        • namestringrequired
        • kindstringrequired
          Always "outcome"
        • outcomesarray of objectrequired
          minItems: 1
          Show item properties
          • idstringrequired
            One of "positive", "warning"
          • labelstringrequired
          • hintstring
      • Alternative 3object

        overdue once the deadline for adding referees has passed and the candidate has not added all requested referees.

        Show properties
        • idstringrequired
          Always "reference_check_referees_overdue"
        • namestringrequired
        • kindstringrequired
          Always "outcome"
        • outcomesarray of objectrequired
          minItems: 1
          Show item properties
          • idstringrequired
            One of "overdue", "not_overdue"
          • labelstringrequired
          • hintstring
      • Alternative 4object

        warning when a behavioural trait fell outside the target range, insufficient when too few referees answered to compare against the benchmark.

        Show properties
        • idstringrequired
          Always "reference_check_behaviours"
        • namestringrequired
        • kindstringrequired
          Always "outcome"
        • outcomesarray of objectrequired
          minItems: 1
          Show item properties
          • idstringrequired
            One of "positive", "warning", "insufficient"
          • labelstringrequired
          • hintstring
      • Alternative 5object

        warning when a referee reported a counterproductive work behaviour.

        Show properties
        • idstringrequired
          Always "reference_check_cwb"
        • namestringrequired
        • kindstringrequired
          Always "outcome"
        • outcomesarray of objectrequired
          minItems: 1
          Show item properties
          • idstringrequired
            One of "positive", "warning"
          • labelstringrequired
          • hintstring
      • Alternative 6object

        How strongly the referees recommend the candidate, in percent.

        Show properties
        • idstringrequired
          Always "reference_check_recommendation"
        • namestringrequired
        • kindstringrequired
          Always "score"
        • rangeobjectrequired
          Show properties
          • minnumberrequired
            Always 0
          • maxnumberrequired
            Always 100
      • Alternative 7object

        A criterion this document does not list yet. Ignore it unless you know its id.

        Show alternatives
        • Alternative 1object
          Show properties
          • idstringrequired
          • namestringrequired
          • kindstringrequired
            Always "outcome"
          • outcomesarray of objectrequired
            minItems: 1
            Show item properties
            • idstringrequired
            • labelstringrequired
            • hintstring
        • Alternative 2object
          Show properties
          • idstringrequired
          • namestringrequired
          • kindstringrequired
            Always "score"
          • rangeobject
            Show 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"
          }
        ]
      }
    ]
  }
}
401text/plain

The token is missing, unknown, revoked, or the integration is not enabled for the account. All four look the same.