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: Share your Harvest API Key
Send the Harvey API key you created in Step #3 to SquarePeg through a secure messaging platform (e.g., Slack, Zoom, Meet, etc.).