Page cover

Integrating with Greenhouse

Prerequisites

Greenhouse Setup Step 1: Create an API key Step 2: Assigning Relevant Permissions

Drivetrain uses API keys to integrate with Greenhouse, utilising the Harvest API type, which is designed to allow Greenhouse customers to push their data from Greenhouse. For more information about the Harvest API, refer to the Harvest API documentation. This guide shows how to create an API key in Greenhouse and select the relevant permissions for the data you want to ingest into Drivetrain.

Prerequisites

To connect Greenhouse to Drivetrain, you need:

  1. An active Greenhouse Admin Account.

  2. Admin Privileges in Drivetrain.

Greenhouse Setup

Step 1: Create an API key

  1. Log in to your Greenhouse account, and click on the Configure (Settings) icon in the upper right-hand corner of any page.

  1. Click on Dev Center in the left panel.

  1. Under Dev Center, Select API Credential Management

  1. Click Create New API Key.

  1. Select the API type as Harvest, enter the description of the API key as “Drivetrain Integration API Key” and click Manage Permissions.

  1. Click the Copy button, store the API key in a safe document, and then click “I have stored the API key.”.

You won’t be able to copy the API key again, so make sure to store it in a safe document.

Step 2: Assigning Relevant Permissions

  1. Select the relevant permissions required for your solution

  1. Drivetrain accesses the following objects using the permissions defined in point 3:

    • Candidates

    • Applications

    • Jobs

    • Users

    • Interviews

    • Scorecards

    • Attachments

    • Interview Stages

    • Offers

    • Offices

    • Departments

    • Activities

    • Reject Reasons

    • Tags

  2. Please find below the permissions required to access the specified objects:

Object Name
Permissions Required

Candidates

GET: List Candidates GET: Retrieve Candidates

Applications

GET: List Applications GET: Retrieve Applications

Tags

GET: List Candidate Tags GET: List tags applied to candidate

Users

GET: List Users GET: Retrieve Users

User Roles

GET: List User Roles

EEOC

GET: List EEOC GET: Retrieve EEOC Data for Application

Scorecards

GET: List Scorecards GET: List Scorecards for Application GET: Retrieve Scorecard

Offers

GET: List Offers GET: List Offers for Applications GET: Retrieve Current Offer for Application GET: Retrieve Offer

Scheduled Interviews

GET: List Scheduled Interviews GET: List Scheduled Interviews for Application GET: Retrieve Scheduled Interview

Activity Feed

GET: Retrieve Activity Feed

Departments

GET: List Departments GET: Retrieve Departments

Email Templates

GET: List Email Templates GET: Retrieve Email Template

Custom Fields

GET: List Custom Fields GET: Retrieve Custom Fields GET: List Custom Field Options

Jobs

GET: List Jobs GET: Retrieve Job GET: Hiring Team

Job Posts

GET: List Job Posts GET: Retrieve Job Post GET: List Job Posts for Job GET: Retrieve Job Post for Job GET: Retrieve Custom Locations for Job Post

Job Stages

GET: List Job Stages GET: List Job Stages for Job GET: Retrieve Job Stage

Job Openings

GET: List Job Openings GET: Single Opening for Job

Offices

GET: List Offices GET: Retrieve Office

Rejection Reasons

GET: List Rejection Reasons

Sources

GET: List Sources

Close Reasons

GET: List Close Reasons

Education

GET: List Degrees GET: List Disciplines GET: Schools

Prospect Pool

GET: List Prospect Pools GET: Retrieve Prospect Pool

Tracking Links

GET: Tracking Link Data for Token

Approvals

GET: List Approvals for Job GET: Retrieve Approval Flow GET: Pending Approvals for User

  1. The minimum permissions needed for this integration are under the Users section:

    1. GET: List Users

    2. GET: Retrieve Users

That’s it. Share the API key with your Customer Success Manager.

PreviousIntegrating with DeelNextIntegrating with Gusto

Last updated

Was this helpful?