RefappRefapp

Submit a candidate

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

Creates the candidate, and the project for candidate.job.id if it does not exist yet. Sending the same ids again updates rather than duplicates. A company block in the body is ignored; the token decides the account.

Authentication

Authorization: Bearer <token>

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

Body

application/json, required

  • partner-eventobjectrequired
    Show properties
    • idstring
    • candidateobjectrequired
      Show properties
      • idnumber | stringrequired
      • first-namestring | null
      • last-namestring | null
      • emailstring | null
      • phonestring | null
      • country-calling-codestring | null
      • refereesarray of object | null
        Show item properties
        • first-namestring | null
        • last-namestring | null
        • emailstring | null
        • phonestring | null
        • country-calling-codestring | null
        • languagestring | null
      • employment-historyarray of object | null
        Show item properties
        • organisationstringrequired
          minLength: 1
        • positionstring | null
          minLength: 1
        • startstringrequired
          pattern: ^\d{4}-(0[1-9]|1[0-2])$
        • endstring | null
          pattern: ^\d{4}-(0[1-9]|1[0-2])$
        • is-currentboolean | null
      • recruiterobjectrequired
        Show properties
        • namestring | null
        • first-namestring | null
        • last-namestring | null
        • emailstringrequired
        • phonestring | null
        • country-calling-codestring | null
        • ats-urlstring | null
        • external-user-identifierstring | array of string | null
          Show alternatives
          • Alternative 1string
          • Alternative 2array of string
      • jobobjectrequired
        Show properties
        • idnumber | stringrequired
        • alternate-idsarray of number | string | null
        • titlestringrequired
        • private-titleboolean | null
        • client-namestring | null
        • recruiting-teamarray of object | null
          Show item properties
          • namestring | null
          • first-namestring | null
          • last-namestring | null
          • emailstringrequired
          • phonestring | null
          • country-calling-codestring | null
          • ats-urlstring | null
          • external-user-identifierstring | array of string | null
            Show alternatives
            • Alternative 1string
            • Alternative 2array of string
        • ats-urlstring | null
        • ats-public-keystring | null
        • ats-namestring | null
        • descriptionstring | null
      • languagestring | null
      • ats-urlstring | null
    • partner-resultobjectrequired
      Show properties
      • idstringrequired
      • statusstring
        One of "sending", "sent", "pending", "completed", "failed"
      • update-urlstring | null
    • webhook-dataobject | null
      Show properties
      • (any other key)string | boolean | number

Responses

200application/json

Accepted. The body is informational; rely on the status code, not its contents.

Show response body
  • messagestring
  • infoobject
Show example
{
  "message": "string",
  "info": {}
}
400application/json

The body did not match the schema.

401text/plain

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