Scout SelectDeveloper Documentation
Assessments

Assign

Assign a candidate to an assessment and get the interview link.

Requires ASSIGN_CANDIDATE_TO_ASSESSMENT. Both the candidate and the assessment must belong to your organisation, or the request fails with NOT_FOUND.

mutation AssignCandidateToAssessment($input: DeveloperAssignCandidateInput!) {
  developerAssignCandidateToAssessment(input: $input) {
    assessmentSessionId
    interviewUrl
    token
    tokenExpiresAt
    emailSent
  }
}
Variables
{
  "input": {
    "candidateId": "clv1a...",
    "assessmentId": "clv2b...",
    "sendEmail": true,
    "expiryDays": 3,
    "callbackUrl": "https://your-app.example.com/hooks/scout",
    "externalReference": "your-internal-id-12345"
  }
}
  • sendEmail defaults to true - set false to deliver interviewUrl yourself.
  • expiryDays defaults to 3 and controls how long the interview link stays valid.
  • interviewUrl and token are both returned so you can either redirect the candidate directly or store the token for your own link generation.
  • callbackUrl is optional. When set, Scout Select will POST a signed webhook to that URL once the report is ready (or fails to generate) instead of you having to poll Report Status
    • see Webhooks. It requires API-key authentication (rejected with BAD_USER_INPUT for org-admin session callers), must be HTTPS, and must match your organization's allowed webhook domains if you've configured one (see Authentication).
  • externalReference is optional and echoed back verbatim in the webhook payload, useful for correlating the callback with your own record without an extra lookup.