EBI is one of the largest privately held screening firms in the country, providing background screening, drug testing, occupational health screening, return-to-work solutions, and electronic Form I-9 and E-Verify services for employment, contract and volunteer positions for over 5,000 clients in the US and globally.
Greenhouse Recruiting’s integration with EBI allows your organization to launch background screening for candidates directly from Greenhouse. With this integration, the "one-step" process sends a background check order to EBI from Greenhouse. Users can then visit EBI to view the results. With EBI's optional "one-plus" or "two-step" process, the status of the background check order is returned to Greenhouse via the candidate Activity Feed.
In this article, we will cover how to:
Retrieve EBI's Endpoint URL and Secret Key
Before enabling the Greenhouse / EBI integration, Greenhouse Recruiting will need two pieces of information:
- EBI's Endpoint URL
- EBI's Secret Key
To retrieve this information please contact your EBI account manager or email the EBI integrations team at email@example.com.
Configure User Setup Permissions in Greenhouse Recruiting
After you have received your endpoint URL and Secret Key from EBI, 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.
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 User-Specific Permissions panel on your user page and expand the Developer Permissions dropdown menu.
Select Can manage and configure web hooks so that a check is in the checkbox. When finished, click Save.
Enable the Greenhouse / EBI Integration
With EBI's endpoint URL and Secret Key copied, and your Greenhouse user permissions enabled, you are ready to enable the Greenhouse / EBI integration.
To enable the integration, 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.
You will be directed to a new page where you Create a New Web Hook. From this page provide the following details:
- Name: We suggest EBI Integration
- When: Configure according to the information received from EBI.
- Endpoint URL: Enter the Endpoint URL received from EBI.
- Secret Key: Enter the Secret Key received from EBI.
When finished, click Create Web hook.
Set Up Background Check Packages
EBI background check package options should be set up in Greenhouse as custom job fields. This way, when a new job is created, a background package is assigned to the job. This default package can optionally be overwritten when the background check is submitted on individual candidates.
To create a custom job field, click the Configure icon in the upper right-hand corner and navigate to Custom Options on the left-hand panel.
On the Custom Options page, click Jobs under the Company Custom Fields section.
On the Custom Fields: Jobs page, click the Add Field button to create a new custom job field.
On the New Job Field page, customize the new job field for EBI:
- Name: Background Check Package
- Description: Optional
- Only show for these offices/departments: Optional
- Field type: Single-select
- Options: Enter the background check package options configured in EBI.
When finished, click Save.
(Optional) Create Harvest API Key for the Greenhouse / EBI Integration
With the "one-plus" or "two-step" process, EBI can return the status of a background check order to Greenhouse via the candidate Activity Feed. This optional step requires a Harvest API key.
Note: In order to create a Harvest API key, a user must have the permission "can manage ALL organization's API Credentials." Read more here: Developer Permissions.
To create a Harvest API key for the integration, click on 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 EBI.
From the Create new credential dialog box, give your API key a name and select Harvest from the Type dropdown menu. When finished, click Create.
On the Manage API Key Permissions page, Select All. When finished, click Update.
Your Harvest API key for the Greenhouse Recruiting / EBI integration is created and configured. Provide your Harvest API key to your EBI account manager so they can finishing setting up the integration.
Use EBI with Greenhouse
Once setup is complete, when recruiters move candidates to a predefined triggering stage, Greenhouse will send background check information to EBI to initiate the order. For a "one-step" setup, this completes the process. Background check results will populate in EBI once complete.
If Harvest API is enabled for the "one-plus" or "two-step" setup, updates are posted back to Greenhouse as the background check is processed. Once screening is complete, a link on the candidate's Activity Feed will direct to EBI for screening results.