Set up an assessment API partner integration

Permissions: Job Admin and above

Product tier: Available for all subscription tiers

The Assessment API can be used to create custom take home test integrations on Greenhouse Recruiting including coding tests, video interviews, and personality tests. Assessment API is designed to import test options from a third-party system to Greenhouse Recruiting.

When candidates reach a predetermined job stage in Greenhouse Recruiting, the third-party can be triggered to send a test to the candidate. The test status is subsequently updated in Greenhouse Recruiting when the candidate completes the assessment on the third-party platform.

Ask the partner for an API key

To enable the integration, contact the partner to request an API key for your integration. 

Note: Some partners allow you to generate an API key directly in their application, or provide the API key by other means. Check your specific partner's documentation for further information.

Once you have received your API key, click here to open a ticket with Greenhouse Support.

Note: Do not send your API key in the initial ticket. If needed, Greenhouse Support will respond with a SendSafely link for you to securely share the API key.

Wait for a confirmation email from Greenhouse Support. You may be required to verify your account before you can proceed.

If they need your API key, Greenhouse Support will provide a SendSafely link where you can enter your API key. Once Greenhouse Support has been notified that you’ve entered your API key, they will send a confirmation email.

Add a partner assessment stage to an interview plan

Once an assessment integration is enabled for your organization, you’ll be able to add the partner’s assessment as an interview stage.

To add an interview stage to an existing job, navigate to your job (All Jobs > Job Name) and click Job Setup.

Screenshot-of-job-setup-tab.png

Select Interview Plan on the left side of the page and click Add stage.

Screenshot-of-add-stage-button.pngScroll through the list and select the partner’s stage on the next window. When you’re finished, click Add to apply the stage to the job's interview plan.

Screenshot-of-partners-name-stage.png

Set up the assessment on the partner stage

After the stage has been added to the job's interview plan, you’ll need to add the assessment to the stage. To add the assessment, click Edit Take Home Test.

Choose the assessments from the dropdown menu. These options are based on the assessments you configured in the partner’s system.

Assign at least one Greenhouse Recruiting user to review and grade submitted assessments. When you’re finished, click Save.

Note: All configuration for the assessment (including the email template) will need to be done in the partner’s system.

Send and review a test

When candidates are moved into the assessment stage, Greenhouse Recruiting will display a Send Test link.

Check out your partner’s documentation on the Greenhouse support site for more information on how this functions with specific integrations.