Integrating Greenhouse with Beamery is easy and takes just a few minutes to enable full synchronization of contacts between both platforms. The steps below will walk you through the step by step process to set up the integration. The approximate time needed to complete all steps in each environment is 2 hours.
Table of Contents
Step 1: Generate Partner API Key in Greenhouse
Step 2: Add the Partner API key from Greenhouse into Beamery
Step 3: Generate Harvest API Key in Greenhouse
Step 4: Adding the Harvest API Key from Greenhouse into Beamery
Step 5: Set Harvest API Permission Settings
Step 6: Beamery Webhooks - Add to Greenhouse
Prerequisites: Before you begin
To successfully connect Greenhouse to Beamery there must be one matching email address in each system. This should either be a real site admin user account or if possible, a site admin email address specific to the Beamery integration (i.e. BeameryGHIntegration@emaildomain.com). You will need to ensure a Greenhouse Admin user email address is provided to your integration consultant. Here is how your Greenhouse site admin user permissions should look:
Step 1: Generate Partner API Key in Greenhouse
1. To set up the Beamery integration with Greenhouse, start in your Greenhouse account (ensure you are a super admin), then select the cog icon from the menu at the top right of your screen. This will bring you to the Configure page.
2. On the left hand side menu, select 'Dev Centre' and then click on 'API Credentials', also on the left hand side menu.
3. On the API Credentials page, click the 'Create New API Key' button. The 'Create New Credential' window will now appear. Enter in the following values in the screenshot below, then click ‘Create’:
4. Copy the API key generated in Greenhouse.
Step 2: Add the Partner API key from Greenhouse into Beamery
1. Using a Super Admin account, login to your Beamery tenant.
2. Navigate to Settings under your account dropdown in the top right of the screen.
3. Select 'Greenhouse' located under 'Data management’ section. This will take you to the Greenhouse integration page.
4. On the Greenhouse integration page, paste the Partner API key onto the first line 'Export to Greenhouse - Ingestion API Key *' Keep this tab open in your browser as you will need to come back to it in step 4. Do not click on save credentials yet.
Step 3: Generate Harvest API Key in Greenhouse
1. Return to the Greenhouse API integrations page where you generated the Partner API key.
2. On the API Credentials page, click the 'Create New API Key' button. The 'Create New Credential' window will now appear. Enter in the values seen in the screenshot below:
Step 4: Adding the Harvest API Key from Greenhouse into Beamery
1. Copy the 'Harvest' API key across from Greenhouse to Beamery. Paste the Harvest API key onto the second line 'Import to Beamery - Harvest API Key *'. Click Save Credentials.
2. Now that you have added the second and final API key into Beamery, click on 'Update Credentials'. You will then see a Secret Key and Endpoint URL, as seen below (keep note of these):
Step 5: Set Harvest API Permission Settings
1. Select API Credential Management option from within the Greenhouse Dev Centre, and then click on the edit option next to the Harvest API you created earlier.
Step 6: Beamery Webhooks - Add to Greenhouse
1. Return to your Greenhouse account and select the cog icon from the menu at the top right of your screen. On the 'Configure' page, select 'Dev Centre' from the menu and then click 'Web Hooks'.
2. Click the link 'Web Hooks' at the top of the list to go to the page 'Create A New Web Hook'. You will need to create each webhook. Keep the name of the webhook the same as whatever you select in the ‘When’ dropdown field. You will also need to enter in the Endpoint URL and Secret Key that you generated in the Beamery platform for each webhook.
*See below for an example of a web hook configuration:
-
Candidate has submitted application (Add new candidate to Beamery and links to a job)
-
Delete Application (Removes a contact from a linked Greenhouse job application)
-
Application Updated (Specific vacancy/application updates performed)
-
Offer Deleted (Updates Contact)
-
Delete Candidate (Does not delete a contact from Beamery, breaks the sync link)
-
Candidate has been hired (Updates contact)
-
Candidate has changed stage (Updates candidate’s vacancy stage in Beamery)
-
Candidate or Prospect Rejected (Adds candidate’s rejection reason in Beamery. Does not change the candidate’s stage as there is no rejection stage in Greenhouse)
-
Candidate or Prospect Unrejected (Removes rejection reason in Beamery)
-
Candidate or Prospect Updated (Updates Candidate or Prospect)
-
Prospect Created (Adds new prospect to Beamery)
-
Merged Candidate (Merges contacts in Beamery)
-
Candidate anonymized (Anonymizes the contact in Beamery)
-
Candidate has been unhired (Updates contact)