27min

Integrating Greenhouse and the ChartHop Greenhouse app

This section covers the process for setting up your API to begin syncs between Greenhouse and the ChartHop Greenhouse App.

1. Obtain your API credentials from Greenhouse

To get started, you will need to obtain API access from Greenhouse. You'll need to obtain an API key by following the steps below.

  1. Access Apps and Docs.
  2. Open Greenhouse.
  3. Ensure that your user has been granted the Can manage ALL organization’s API Credentials permission in “Developer permissions.” You may need help from a Greenhouse admin.
  4. Navigate to the API Credentials page in the Dev Center.
  5. Select Create New API Key
  6. For API Type, select Harvest. For Partner, select ChartHop. For Description, leave the default entry.
  7. Copy the Harvest API Key.

Once you've received the necessary information from Greenhouse, do not share this information with anyone outside of your organization, as it enables direct access to your data within Greenhouse.

The following permissions must be applied to the Harvest API Key. Leave all options as default, and manually enable the options below.

Type

Permissions

Users

GET: List Pending Approvals

PUT: Add a job permission

User role

GET: List user roles

Custom fields

GET: Custom Fields

GET: Custom Field Options

2. Install the Greenhouse App in ChartHop

In order to use the API credentials you gathered above, you'll need to install the Greenhouse app in ChartHop. To install the Greenhouse app, simply:

Figure 1: Navigate to the Greenhouse App thorough Apps and Integrations
Figure 1: Navigate to the Greenhouse App thorough Apps and Integrations
  1. Navigate to Apps and Integrations in ChartHop.
  2. Find Greenhouse in the list of available apps.
  3. Select Install on the far right-hand side of the table.

3. Enter your Greenhouse API credentials, and other config settings

Figure 2: Input your API credentials in the Settings section of the configuration options
Figure 2: Input your API credentials in the Settings section of the configuration options

In order for ChartHop to access your Greenhouse data, you'll need to enter the Greenhouse API credentials you obtained above. In addition, there are a number of other configuration settings available to you.

Greenhouse sync options are the following:

Field

Description

Greenhouse Domain

The domain used by your Greenhouse instance. For example, if your domain is example.greenhouse.io, then your subdomain is example.

Harvest API Key

The Harvest API key generated in Greenhouse.

Run Daily

With this option enabled, the ATS app will run automatically every day.

Resync On Daily Run

With this option enabled, ChartHop will update Greenhouse with new changes on the daily run.

Sync On Change

With this option enabled, changes to job statuses will be automatically pushed to Greenhouse when they are made.

Reverse Sync

With this option enabled, the sync direction is reversed - Greenhouse becomes the system of record, and ChartHop is updated with new open roles from Greenhouse.

Reconciliation

When enabled, reconciles Greenhouse role and field data with ChartHop. This option cannot be used with Reverse Sync enabled. Learn more.

Remote Location As Default

With this option enabled, newly synced records that are not assigned a location will be assigned the value Remote Location.

Reuse Closed Jobs

With this option enabled, formerly closed jobs will be reused for closely matching, newly opened jobs.

Match Jobs By Job Code

When enabled, will set ChartHop job codes to match job Requisition ids in Greenhouse. Job codes will be used in junction with Group Job Openings. Learn more.

Configuring options

For which options to choose when configuring your settings, we recommended the options illustrated below:

Figure 3: Greenhouse ChartHop app recommended setup
Figure 3: Greenhouse ChartHop app recommended setup

On the right are the required settings for the ChartHop Greenhouse App which include:

  1. Run Daily (minimum required setting)
  2. Sync on Change (minimum required setting)
  3. Reuse Closed Jobs

On the left, you'll find the corresponding Status Mappings between ChartHop and Greenhouse when creating new roles.

4. Set up the Candidate Hired webhook

In order to notify ChartHop of roles that have been hired in Greenhouse, you will have to set up a webhook in Greenhouse.

Figure 4: Create your webhook and access your secret key by adding your Harvest API Key
Figure 4: Create your webhook and access your secret key by adding your Harvest API Key

Follow the steps below to set up the webhook.

  1. Navigate to the Greenhouse app config page in ChartHop.
  2. Copy the secret key value under Webhook Setup.
  3. Open Greenhouse.
  4. Navigate to the Webhooks page.
  5. Select Webhooks.
  6. Select Create a new webhook.
  7. Enter the information below and save your changes.

Field

Value

Name this webhook

charthop-hire

When

Candidate has been hired

Endpoint URL

https://webhook.charthop.com/v1/webhook/app/greenhouse/5a12dddd6f2b8f0e63fc8e64/5b15fbf1bd35a93451fc5df3

Secret Key

[Obtained above]

Error recipient email

support@charthop.com

Disabled

No

Once the above information has been entered, ChartHop will automatically update open jobs that have been filled in Greenhouse.

5. Configure your role openings

ChartHop offers a couple of ways to group openings under one requisition in Greenhouse.

Figure 5: Navigate to the Group Job Openings section in the configuration options to manage your open role groupings
Figure 5: Navigate to the Group Job Openings section in the configuration options to manage your open role groupings
  1. Navigate to the Apps and Integrations page
  2. Select Greenhouse.
  3. Scroll down to Group Job Openings.

You will then have three options. They are as follows: 

  1. Title: Matching on Job Title will take all roles opened within ChartHop with a similar title and group those openings under one requisition once pushed to Greenhouse.
  2. Title and Location: Matching on Job Title and Location will take all roles opened within ChartHop with a similar title AND location and group those openings under one requisition once pushed to Greenhouse. 
  3. ”Loose” Matching: Please contact your CSM or Support team for additional options. 

These openings will still show up as separate roles in ChartHop. They will only be grouped under the same opening on the Greenhouse end.



Updated 11 May 2022
Did this page help you?
Yes
No