Note: An updated version of the Greenhouse Recruiting / Good Hire integration is available. For the most current version, click here.
GoodHire is an employment background check that is built for trust and safety in the workplace. From personal background checks to employment background checks, GoodHire will help you find the best people for the job.
Greenhouse Recruiting and GoodHire have built an integration to seamlessly add a background check into your Interview Plan and receive notifications. In this article, we will cover:
- Prerequisites
- Configure User Setup Permissions in Greenhouse Recruiting
- Configure Webhooks for the Greenhouse Recruiting / GoodHire Integration
- Create Harvest API Key for the Greenhouse Recruiting / GoodHire Integration
- Optional: Set Up Reports to Order Automatically
- Optional: Set Up Automatic Stage Changes
- Running Reports
Prerequisites
Before activating the Greenhouse Recruiting and GoodHire integration, the following conditions should be met:
- Your organization must have a Greenhouse Recruiting account and a GoodHire account already created.
- Your organization must be on Invoice Billing with GoodHire.
- The user configuring the integration must have developer permissions in Greenhouse Recruiting
- The user configuring the integration must have the Company administrator role in GoodHire
Configure User Setup Permissions in Greenhouse Recruiting
In order to enable the Greenhouse/GoodHire integration, you will need the following developer permissions:
- Can manage ALL organization’s API Credentials
- Can manage and configure web hooks
Contact a Greenhouse user in your organization with Site Admin level permissions with the additional user-specific permission Can edit another user's advanced permissions to apply the developer permissions to your account. Have the user with Site Admin level permissions edit your user account's permissions by navigating to the Configure icon 
> Users > Your Name.
The user with Site Admin level permissions should navigate to the Permissions panel on your user page and expand the Developer Permissions dropdown menu.
Select Can manage ALL organization’s API Credentials and Can manage and configure web hooks so that a check is in each checkbox. When finished, click Save.
Configure Webhooks for the Greenhouse Recruiting / GoodHire Integration
On the Integrations page of your GoodHire account, click the toggle next to Greenhouse to On.
If you want to trigger reports to be sent to GoodHire from a certain stage, enter the stage name where the candidate will be exported from and click Save.
If you want to trigger reports to be sent to GoodHire when candidates are marked as hired, you can ignore the Enter export stage field.
The settings page displays the Endpoint URL and Secret key you need to create a webhook in Greenhouse. Copy these values to enter in Greenhouse Recruiting in the following steps.
With GoodHire’s endpoint URL and Secret Key copied, and your Greenhouse user permissions enabled, you are ready to enable the Greenhouse Recruiting / GoodHire integration.
To enable the integration, return to Greenhouse Recruiting and click the Configure icon in the upper right-hand corner and navigate to Dev Center on the left-hand panel. From the Dev Center page, click Web Hooks.
Click Web Hooks from the subsequent page.
Once you reach the Create A New Web Hook page, you will need to decide when you want to export candidates from Greenhouse Recruiting to GoodHire. If you want to export candidates during one of your workflow stages, you will configure the webhook to occur when Candidate has changed stage; if you want to export candidates when they are marked as hired, you will configure the webhook to occur when Candidate has been hired.
Once you have made this decision, provide the following details:
- Name: GoodHire
- When: Candidate has changed stage or Candidate has been hired
- Endpoint URL: The Endpoint URL copied from GoodHire
- Secret Key: The Secret Key copied from GoodHire
When finished, click Create Web hook.
Create Harvest API Key for the Greenhouse Recruiting / GoodHire Integration
To create a Harvest API key for the integration, click the Configure icon in the upper right-hand corner. Navigate to Dev Center on the left-hand panel. From the Dev Center page, click API Credential Management.
From the API Credential Management page, click Create New API Key to generate the API key for GoodHire.
In the Create New Credential dialog box, make the following selections:
- API Type: Harvest
- Partner: GoodHire
- Description: GoodHire Harvest API Key
When finished, click Manage Permissions to generate the Harvest API key and automatically assign it the appropriate permissions required by GoodHire.
In the subsequent dialog box, click Copy to save your API key to your clipboard. Store the API key in a secure location to provide to GoodHire in the next step. Click I have stored the API Key once you have copied and saved the key.
Note: You cannot access the full Harvest API key again after clicking I have stored the API Key. If you lose your API key and need to access it later, you must create a new API key, provide it to the integration partner, and then revoke access to the original key.
On the subsequent page, confirm the following permissions are assigned to your new API key:
|
Activity Feed:
|
 |
|
Applications:
|
 |
|
Candidates:
|
 |
|
Job Posts:
|
 |
|
Job Stages:
|
 |
|
Jobs:
|
 |
|
Offers:
|
 |
|
Offices:
|
 |
|
Users:
|
 |
If any of the permissions above are not checked, place a check in the box next to the appropriate permission. Click Save when finished.
Your Harvest API key for the Greenhouse Recruiting / GoodHire integration is created and configured.
Return to your GoodHire Integrations page. Paste your Harvest API key into the API Key field and click Save.
Optional: Set Up Reports to Order Automatically
These steps should only be followed if you want reports to automatically begin processing. If these steps are not followed, or applied, a report will still be Queued within GoodHire like normal.
In Greenhouse Recruiting, click the Configure icon and navigate to Custom Options in the left-hand panel.
From the subsequent page, click Jobs in the Company Custom Fields section.
From the Custom Fields: Jobs page, click Add Field.
Create a new custom job field with the following details:
- Field name: GHBGCheck
- Type: Single select
- Options: Enter the background check ID(s) provided to you by the GoodHire team. If you have not set up product bundles yet with GoodHire, wait to add the options until finalized with Sales.
- Expose in Job Board API: check this box
Click Save when finished.
Repeat the steps above to create a second custom job field using the following details:
- Field name: GHBillingCode
- Type: Single select
- Options: Billing Code ID(s) you want to associate within GoodHire.
- Expose in Job Board API: check this box
Click Save when finished.
Navigate to the job where you want to set the Background Check Type and click the Job Setup tab. Navigate to the Job Info panel and click Edit.
From the Job Info page, locate the custom job fields created in the previous step. Select the background check package you want to be run and the billing code you want to be associated with the background check order.
Optional: Set Up Automatic Stage Changes
In GoodHire, if you leave these values blank, the candidate's stages will not be moved within Greenhouse.
Select what stage the candidate will be moved to when the report begins processing.
Select what stage the candidate will be moved to when the report completes.
Running Reports
When you mark a candidate hired in Greenhouse Recruiting or move them to your designated export stage, their information is automatically exported to GoodHire.
If you set a notification user on the integration setup page in GoodHire, that user will receive an email stating the candidate has been exported to GoodHire.
If you have added the background check type, the report will automatically be ordered within GoodHire instead of moving them to the Queued Results section.
The candidate now appears in the Queued Results tab of your GoodHire dashboard. Click the Run button to begin the order.
Select your package type from the dropdown.
Click the Run a different check button to build a check package from scratch as needed for a specific candidate.
Click the Run this package button to run the selected package on the candidate.
The report has been ordered and the candidate will appear in the Hiring Results tab of your GoodHire Dashboard.
GoodHire automatically creates notes on the candidate's Activity Feed showing when a report is ordered, when it begins processing, and when it is complete. These status updates also include a link directly to the report results.
