In-line assessment ordering process

🛑

Assessment API Sunset

This API has been deprecated since September 4, 2023. The sunset date is June 10, 2024. If you are an assessment provider or looking to build an assessment integration with SmartRecruiters, please consider using the new Assessment API (2021).

We allow our customers to configure one in-line assessment offer per hiring process. Each job created by our customer is linked to exactly one hiring process.

When a candidate applies to a job that has a hiring process with an in-line assessment configured, we send a POST request to your order-handling service. InlineAssessmentOrderRequest object is sent as a payload of the request.

We expect that your service responds with InlineAssessmentOrderResponse object and HTTP code 200. In case of a failure, your service should respond with HTTP code 4xx or 5xx. An optional error message can be provided in the rejectionReason field of InlineAssessmentOrderResponse object.

Instantly after receiving a response from the service, we redirect a candidate to a URL that you provided in the inlineAssessmentUrl field of InlineAssessmentOrderResponse object. After completing your assessment the candidate must be redirected back to the URL provided in the completedAssessmentCallbackUrl field of InlineAssessmentOrderRequest object.

As the last step, you have to submit a result of the assessment. You can find more information on submitting a result here.

📘

Note

When a candidate finishes the application process we automatically create an assessment order and mark it as completed. When you submit an in-line assessment result we automatically attach it to the order. You can browse the orders using Assessment API.

Example of InlineAssessmentOrderRequest object:

{
    "applicationOperationId": "9ee2f66a-ea6f-11e9-81b4-2a2ae2dbcce4",
    "candidate": {
      "firstName": "John",
      "lastName": "Smith",
      "email": "[email protected]",
      "language": "en"
    },
    "completedAssessmentCallbackUrl": "https://jobs.smartrecruiters.com/oneclick-ui/company/1234/job/4321/publication/5678",
    "assessmentResultUrl": "https://api.smartrecruiters.com/v1/inline-assessments/results/776f584f-1fa6-44f6-8e94-d9daacc3dc3d",
    "partnerClientId": "SmithsRestaurants",
    "partnerInlineAssessmentTypeId": "CooperationSkillsTest",
    "offerCatalogId": "ab-32-gf-asd",
    "job": {
	"uuid": "aaf65646-ed93-4c16-950b-cea69773efba",
	"location": {
		"country": "US",
		"city": "San Francisco",
		"region": "CA",
                "address": "6054 Shook Road"
	},
	"customFields": [
	{
            "fieldId": "5a3a2f5225f6d07d0721e105",
            "fieldLabel": "Brand",
            "valueId": "default",
            "valueLabel": "Silo"
        }
	]
    }
    "company": {
        "id": "511a3942300469a9c33819d1",
        "name": "Orlando Magic Inc."
    }
}

Example of InlineAssessmentOrderResponse object:

{
   "inlineAssessmentUrl": "https://www.vendordomain.com/assessments/cooperation-skills/36436f1c-c60a-4eee-8909-ccc04f74b9f5",
   "rejectionReason": ""
}