Overview
SquarePeg's integration with Greenhouse allows users to import jobs into SquarePeg and ensure candidates sourced by SquarePeg are exported to the right job in Greenhouse. Learn more.
Need help? Schedule an integration call and we'll walk you through the integration setup.
Integration Instructions
Step 1: Create an ISU
SquarePeg recommends creating a new user in Greenhouse. This user will act as your "ISU" (i.e. Integration System User.) In other words, this user will be credited with adding SquarePeg candidates to Greenhouse. In the screenshot below the ISU is "SquarePeg Integration".
To create an ISU, follow the instructions in this article:
When creating your ISU, SquarePeg recommends something like "squarepeg@yourdomain.com" for the email address. (This makes it easy for the SquarePeg team to identify the right user.)
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 Harvest API key
To create a Harvest API key, follow the instructions in this article:
Select the credentials below when configuring the Harvest API key:
Note: When you select “SquarePeg” as partner, the permission should populate automatically. However, we still recommend reviewing them to ensure they are correct.
Credentials
In the Create New Credential box, make the following selections:
- API Type: Harvest
- Partner: SquarePeg
- Description: SquarePeg Harvest API Key
Permissions
Select the permissions below when configuring the Harvest API key:
Applications
- GET: Retrieve application
- GET: List applications
- PATCH: Update application
- POST: Move application
- POST: Reject application
- POST: Moves application to job
- POST: Unreject application
- POST: Add attachment to application
- PATCH: Update a rejected application's rejection reason
Candidates
- GET: Retrieve candidate
- GET: List candidates
- PATCH: Edit candidate
- POST: Add candidate
- POST: Add note
- POST: Add e-mail
- POST: Add attachment
- POST: Add application
- POST: Add education
- DELETE: Delete education
- POST: Add employment
- DELETE: Delete employment
Users
- GET: Retrieve user
- GET: List users
Jobs
- GET: Retrieve job
- GET: List jobs
- GET: Get hiring team
Job posts
- GET: List job posts
- GET: Retrieve job post for job
- GET: List job posts for job
Job stages
- GET: Retrieve job stage
- GET: List job stages
- GET: List job stages for job
Rejection reasons
- GET: List rejection reasons
Sources
- GET: List sources
Step 3: Contact SquarePeg
In order to continue with the integration, you'll need to schedule an integration call.
On this call, SquarePeg will ask you for the Harvey API key that you created in Step #2. SquarePeg will also provide you with an "Endpoint URL” and “Secret Key” for the purpose of setting up a webhook in Greenhouse which will allow you to complete Step #4 and complete the integration setup.
Step 4: Create webhooks
Once you've received an Endpoint URL and Secret Key from SquarePeg, you need to create nine (9) separate webhooks.
To create a webhook, follow the instructions in this article:
Use the values listed below when configuring the webhook:
- Name
- SquarePeg integration [and name of when value]
- When
- Candidate has been hired
- Candidate has been unhired
- Candidate has changed stage
- Candidate or prospect rejected
- Candidate or prospect unrejected
- Delete application
- Delete candidate
- Job deleted
- Job updated
- Endpoint URL
- The Endpoint URL provided by SquarePeg
- Secret Key
- The Secret Key provided by SquarePeg