Ashby - Assessments Setup Guide

This guide will help you configure Ashby Assessments integration using Knit.

Prerequisites

Partnership with Ashby for assessments integration

Guide

Follow the steps below to setup ashby assessments integration via knit.

First, you need to create an Ashby integration.
Once your Ashby integration is created, you need to generate the specific secrets that Ashby requires for assessments integration. Use the Create ATS Assessment Secrets Endpoint
Ashby requires two pieces of information to complete the assessments integration setup: API Key - secretKey from the above api response. Base URL - baseUrl from the above api response.
Provide these values to Ashby through your partnership channel. These credentials will allow Ashby to send assessment-related webhooks through Knit
For more details about ashby assessment workflowrefer here and for ashby partners related information refer here

Supported Events

record.new

The record.new event is triggered by Knit when Ashby sends an assessment.start request. This event is sent to the webhook URL registered for the ATS category.

Example Event Payload:

{
  "eventType": "record.new",
  "eventData": {
    "candidateAssessment": {
      "applicationId": "app_123abc",
      "assessmentPackage": {
        "description": "Technical Skills Assessment",
        "id": "pkg_456",
        "metaData": null,
        "name": "Frontend Engineer Assessment",
        "type": "SKILLS_TEST"
      },
      "callbackUrl": null,
      "candidate": {
        "emails": [
          {
            "email": "[email protected]",
            "type": "PRIMARY"
          }
        ],
        "firstName": "Alex",
        "id": "cand_789xyz",
        "lastName": "Chen",
        "links": null,
        "location": "San Francisco, CA",
        "phones": null
      },
      "id": "ats_ass_a1b2c3d4e5f6g7h8i9j0k",
      "jobId": "job_456def",
      "metaData": null,
      "originData": {
        "application": {
          "ashby_id": "app_123abc",
          "status": "IN_REVIEW"
        },
        "assessment_type_id": "pkg_456",
        "candidate": {
          "ashby_id": "cand_789xyz",
          "email": "[email protected]",
          "first_name": "Alex",
          "last_name": "Chen"
        },
        "job": {
          "ashby_id": "job_456def",
          "name": "Senior Frontend Engineer"
        }
      },
      "status": "NOT_SPECIFIED"
    }
  },
  "eventId": "evt_1734567890123",
  "recordId": "ats_ass_a1b2c3d4e5f6g7h8i9j0k",
  "syncType": "real_time",
  "syncDataType": "ats_assessments",
  "syncJobId": "ats_assessments_real_time",
  "syncRunId": "real_time_1734567890123",
  "triggeredAt": 1734567890123
}

record.deleted

The record.deleted event is triggered by Knit when Ashby sends an assessment.cancel request.

Example Event Payload:

{
  "eventType": "record.deleted",
  "eventData": {
    "candidateAssessment": {
      "applicationId": null,
      "assessmentPackage": {
        "description": null,
        "id": null,
        "metaData": null,
        "name": null,
        "type": null
      },
      "callbackUrl": null,
      "candidate": {
        "emails": null,
        "firstName": null,
        "id": null,
        "lastName": null,
        "links": null,
        "location": null,
        "phones": null
      },
      "id": "ats_ass_x9y8z7w6v5u4t3s2r1q0p",
      "jobId": null,
      "metaData": null,
      "originData": {
        "assessment_id": "ats_ass_x9y8z7w6v5u4t3s2r1q0p"
      },
      "status": "CANCELLED"
    }
  },
  "eventId": "evt_1734567890999",
  "recordId": "ats_ass_x9y8z7w6v5u4t3s2r1q0p",
  "syncType": "real_time",
  "syncDataType": "ats_assessments",
  "syncJobId": "ats_assessments_real_time",
  "syncRunId": "real_time_1734567890555",
  "triggeredAt": 1734567890999
}

Updated about 2 hours ago