Skip to content

Greenhouse

Greenhouse is a popular applicant tracking system (ATS) and recruiting software used by companies to manage their hiring processes. It offers a range of features designed to streamline recruiting workflows, improve collaboration among hiring teams, and provide insights into recruitment metrics.

Generating API Key to set up Greenhouse connection

  1. Log in to your Greenhouse account as an administrator.
  2. Navigate to the Configure tab and select Dev Center from the dropdown menu.
  3. In the Dev Center, click on API Credential Management.
  4. Click on Create New API Key to generate a new API key.
  5. Make the following selections:
    • API Type: Harvest
    • Partner: Either choose Unlisted Vendor or keep it empty.
    • Description: Enter a descriptive name for your API key, such as "Hire2Retire Key".
  6. After selecting the API type and description, click Manage Permissions to configure the required Harvest API permissions before creating the key.

  7. Select the following permissions based on the configuration of your workflow

    Configuration-Specific Permissions

    Configuration Additional Required Permissions Additional Optional Permissions
    Onboarding using Offer Start Date • Get: List Offers —
    Onboarding using Application Status • Get: Retrieve Application
    • Get: List Applications    		 • Get: Retrieve Application’s Current Offer

    Common Permissions

    • Required

      • Get: Retrieve Candidate
      • Get: List Candidates
      • Get: Retrieve Job

    • Optional

      • Get: Custom field

This permission is optional. Enable it only if your workflow uses custom applicant, candidate, job, or offer fields for mapping in Hire2Retire. --- 

- **Required**

    1. Select **Get: List Offers** permission under Offers

        ![Offers in Greenhouse](../img/Connection/GreenhouseOffersApi.webp){ loading=lazy }
        <div class="image_description">Figure 1. Offers API</div>

    2. Select **Get: Retrieve Application** and **Get: List Applications** permission under Applications

        ![Applications in Greenhouse](../img/Connection/GreenhouseApplicationsApi.webp){ loading=lazy }
        <div class="image_description">Figure 2. Applications API</div>

    3. Select **Get: Retrieve Candidate** and **Get: List Candidates** permission under Candidates

        ![Candidates in Greenhouse](../img/Connection/GreenhouseCandidatesApi.webp){ loading=lazy } 
        <div class="image_description">Figure 3. Candidates API</div>

    4. Select **Get: Retrieve Job** permission under Jobs

        ![Jobs in Greenhouse](../img/Connection/GreenhouseJobsApi.webp){ loading=lazy } 
        <div class="image_description">Figure 4. Jobs API</div>

- **Optional**

    1. Select **Get: Custom field** under the Custom Fields to provide access to Applications, Candidates, Job & Offers Custom Fields

        ![Custom Fields in Greenhouse](../img/Connection/GreenhouseCustomFields.webp){ loading=lazy } 
        <div class="image_description">Figure 5. Custom Fields API</div>

    2. Select **Get: Retrieve Application's Current Offer** under Offers to provide access to Candidate's Start Date

        ![Candidate's Start Date in Greenhouse](../img/Connection/GreenhouseStartDate.webp){ loading=lazy } 
        <div class="image_description">Figure 6. Offers API</div>
  1. Click Create to generate an API key. Make sure to copy and securely store the generated API key since you won't be able to retrieve it again.

Create a Connection

Hire2Retire requires the following details to create a connection with your Greenhouse server:

  • API Key - The Harvest API key generated in Greenhouse, used by Hire2Retire to securely retrieve candidate, job, application, and offer data.

    Connection page

    Figure 7. Greenhouse Connection Set Up page - Create Connection

For workflows that use the Offer Start Date for onboarding, Hire2Retire retrieves:

  • Offers with an Accepted status, and an Offer Start Date that is within the past 6 months from the time the workflow runs.
  • Offers with a Rejected status for the termination events in the IdP.

Configuration

Once you have successfully configured the connections, you can continue with the Design section to configure the rest of the workflow following these steps in order.

  1. ATS Data Definition
  2. ATS to AD Profile Map
  3. Lifecycle Business Rules
  4. Employment Status
  5. Organizational Unit Assignment - Only defined in on-premise Active Directory
  6. Group Memberships
  7. Communication Hub

Deployment

Once your workflow has been setup, you can optionally setup notifications and archival for your workflow.

Otherwise, you can proceed to deploy and test it on the Hire2Retire platform, see Deploy and Test Flow