Good Egg is a trusted partner when it comes to compliance, security, and anything that falls under the drug and background screening umbrellas. Good Egg looks at a candidate's past, present, and future behaviors to paint a more complete picture of a potential candidate and mitigate the risk associated with hiring them.
Greenhouse Recruiting's integration with Good Egg allows you to invite candidates to complete the background screen directly from the candidate's profile page, and receive the screening results in Greenhouse Recruiting once completed, with updates along the way. With Good Egg and Greenhouse Recruiting working together, your candidates and hiring team will experience a faster, more efficient screening process while saving time on manual processes and dual entry.
In this article, we will cover how to:
- Configure User Setup Permissions in Greenhouse Recruiting
- Create Harvest API Key for Greenhouse Recruiting / Good Egg Integration
- Create Good Egg Web Hook
- Use Greenhouse Recruiting / Good Egg Integration
- Get Help
Configure User Setup Permissions in Greenhouse Recruiting
In order to enable the Greenhouse Recruiting / Good Egg 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 noted 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.
Repeat as necessary for any other user that should have access to set up the integration.
Create Harvest API key for the Greenhouse Recruiting / Good Egg 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 Good Egg.
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, grant your API key the permissions listed below, then click Update at the bottom of the page.
- Activity Feed:
- GET: Retrieve Activity Feed
- Candidates:
- POST: Add Note
Your Harvest API key for the Greenhouse Recruiting / Good Egg integration is created and configured. Provide your Harvest API key to your Good Egg onboarding team so they can set up the integration.
Create Good Egg Web Hook
Before enabling the Greenhouse Recruiting / Good Egg integration, Greenhouse Recruiting requires two pieces of information:
- Good Egg's Endpoint URL
- Good Egg's Secret Key
Contact your Good Egg representative to obtain your Endpoint URL and Secret Key. Once you have these two pieces of information, continue with the steps below to create the Good Egg web hook.
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 Web Hooks.
On the subsequent page, click Web Hooks.
You will be directed to a page where you can create a new web hook. From this Create A New Web Hook page, provide the following details:
- Name: We suggest Good Egg BGC
- When: Be sure to select the right web hook so the web hook fires at the appropriate event in Greenhouse Recruiting [Candidate has been hired]
- Endpoint URL: The Endpoint URL received from the Good Egg team
- Secret Key: The Secret Key received from the Good Egg team
When finished, click Create Web hook.
That is it! Your Greenhouse Recruiting account and Good Egg account can now talk to each other.
Use Greenhouse Recruiting / Good Egg Integration
To initiate a background check, first navigate to the desired candidate. The candidate must be in the Offer stage to initiate the screen. Once the candidate is in the Offer stage, Good Egg is auto-notified to generate an invitation link, which is sent to the candidate so they can provide their information for Good Egg to begin the background check. Once the background check is kicked off, depending on your settings, you will be notified of specific actions related to the report in Greenhouse Recruiting under the candidate's Details tab.
Once results are in, a link will be sent through to your Greenhouse Recruiting Dashboard, where you will be able to access the full report.
Get Help
Please contact Allison.Landes@goodegg.io for troubleshooting assistance regarding the integration.