CodeSignal <> Ashby Integration Overview

This guide will walk you through integrating your CodeSignal account with Ashby, sending CodeSignal assessments through Ashby, and creating CodeSignal interviews within Ashby.

• Prerequisites
• Set up the CodeSignal <> Ashby Integration
• Send CodeSignal Assessments with Ashby
• Create CodeSignal Interviews with Ashby

Prerequisites

• Your organization has a working integration in place with Ashby
• You must be logged in to your CodeSignal account

Set up the CodeSignal <> Ashby Integration

Getting started checklist

Note: Make sure you can login to CodeSignal and see the “Webhooks” and “API Keys” sections in your integrations settings panel on the left side here. If you don’t see those options, you’ll need to email support@codesignal.com to request access.

1. Open a browser tab with Ashby on the assessments admin page
2. Open another browser tab with CodeSignal on the API KEYS page

Add the Integration in Ashby

1. Starting from the assessments admin page in Ashby, click Add Integration in the top right. Then, select the CodeSignal integration.
2. Once that’s done, you should see a panel to configure keys for the integration. Click the Ashby API Key drop-down to create or select an existing one for this integration.

Note: Copy the resulting API key, if you created a new one, and keep it in a safe place. You’ll need this for the configuration on the CodeSignal side. Also, you’ll return to this page to input your CodeSignal API key once you have it.

Get the CodeSignal API Key

Next, we need to get an API key from CodeSignal, so that Ashby can interact with CodeSignal.

1. To set up your CodeSignal API key, navigate to the CodeSignal's API Keys page. (Integrations > API Keys) and click ADD A KEY.
   
2.  In the Key Description field, type Ashby Integration and click the arrow.
   
   3. In the pop-up modal, make sure the following permissions are selected and click SAVE.
   • companyTest.company.read
   • companyTestSession.company.write
   • liveInterview.company.read
   • liveInterview.company.write

4. Copy the API key from CodeSignal by clicking on the key (in blue text).

5. Go back to Ashby assessments admin and enter your new CodeSignal API key in the topmost box in the Ashby CodeSignal settings (same place where you started with the Ashby API key setup initially).

Connect the CodeSignal Webhook to Ashby

Next, we’re going to set up the webhook so CodeSignal can notify Ashby about updates to assessments.

1. Set up a new webhook by navigating to the Webhooks tab in your CodeSignal account.

2. Click “ADD A WEBHOOK” in the top right.
   

3. In the screen that appears, configure the following information:

• Add event types:
  • companyTestSessionStarted
    companyTestSessionFinished
    preScreenResultShared
    preScreenResultVerified
    preScreenExpired
    preScreenCandidateDeclined
    preScreenResultNotVerified
    preScreenResultVerificationPending
• Endpoint:  https://app.ashbyhq.com/api/codesignal_webhook
• Secret Key:  paste the API key you just created from CodeSignal (don't click the refresh button).
• Email: assessment-webhooks@ashbyhq.com (automatically notifies us if this webhook fails).
• Custom headers: add one and set the key as X-Ashby-Api-Key and the value as your API key that you generated in Ashby.

1. 4. If all is well, you should be able to click the test button and see a success message. If you run into issues, double check your configuration, and ensure you did the final step from the CodeSignal API key setup, where you save the CodeSignal API key into Ashby.
   5. Once you’re done, click the create button.