Step 1: Create an Integration System User ("ISU")
First, you need to create a new user in Greenhouse. This will be your ISU.
To create an ISU, follow the instructions in this article:
When creating your ISU, SquarePeg recommends using an email address dedicated to SqurePeg, not an individual's. For example, "squarepeg@yourdomain.com" would work well.
When creating your ISU, ensure the following:
- Enter an email address for the user
- Select Site Admin as the permission level
- Make sure that "Send invitation email" is unchecked
Step 2: Create a Custom Source
To create a custom source, follow the instructions in this article:
The name of your custom source should be "SquarePeg".
Step 3: Create a Harvest API Key
To create a Harvest API key, follow the instructions in this article:
Credentials
When configuring the Harvest API Key, enter the credentials below:
- API Type: Harvest
- Partner: SquarePeg
- Description: SquarePeg Harvest API Key
IMPORTANT: Please store your SquarePeg Harvest API Key in a safe place. You will send it to SquarePeg through a secured messaging platform (e.g., Slack, Zoom, Meet, etc.).
Permissions
When configuring the Harvest API Key, enable the permissions below:
Applications
- GET: Retrieve Application
- POST: Add Attachment to Application
- Post: Move Application
- Post: Reject Application
Candidates
- GET: List Candidates
- POST: Add Attachment
- POST: Add Candidate
- POST: Add Note
Job Posts
- Get: List Job Posts for Job
Jobs
- GET: List Jobs
Job Stages
- Get: List Job Stages
Offers
- GET: List Offers
Rejection Reasons
- GET: List Rejection Reasons
Sources
- GET: List Sources
Tags
- GET: List Candidate Tags
- Delete: Remove tag from candidate
- PUT: Add a candidate tag
Users
- Get: List Users
Step 4: Enter your API Key in SquarePeg
Next, paste your API key into SquarePeg and click continue.
Step 5: Set Audit Log User
Set the audit log user by pasting the email address of your integrated system user.
Note: This should be the email address you used in step #1.
Step 6: Set Job Board Token
- Open the Configure Your Job Board page in Greenhouse.
- Copy the value displayed next to "Your Board Token."
- Paste that value into SquarePeg when asked for the job board token.
To finish, click Set up Integration.
Next Steps and What to Expect
After you complete the steps on this page, SquarePeg will begin downloading job and candidate data and enriching candidate resumes. Depending on the number of candidates in your Greenhouse account, this process could take several hours, but it should be shorter for most accounts.
Once candidates for a job are enriched, you can score them by saving job requirements.