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¶
- Log in to your Greenhouse account as an administrator.
- Navigate to the
Configure
tab and selectDev Center
from the dropdown menu. - In the Dev Center, click on
API Credential Management
. - Click on
Create New API Key
to generate a new API key. - Make the following selections:
- API Type: Harvest
- Partner: If your integration is not listed, you can either keep it empty or choose the option for an unlisted vendor.
- Description: Enter a descriptive name for your API key, such as "Hire2Retire Key".
- When finished, click Manage Permissions to generate the Harvest API key.
-
Set the following permissions and save.
In the Applications, select Get: Retrieve Application and Get: List Applications permission.
Figure 1. Applications APIIn the Candidates, select Get: Retrieve Candidate and Get: List Candidates permission.
Figure 2. Candidates APIIn the Jobs, select Get: Retrieve Job permission.
Figure 3. Jobs APIIn the Custom Fields, select Get: Custom field options
Figure 4. Custom Fields API -
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 - An API key is a unique identifier that grants access to the Greenhouse API (Application Programming Interface). The API key serves as a form of authentication, allowing external applications or services to interact with Greenhouse programmatically.
Figure 4. Greenhouse Connection Set Up page - Create Connection
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.
- ATS Data Definition
- ATS to AD Profile Map
- Lifecycle Business Rules
- Employment Status
- Organizational Unit Assignment - Only defined in on-premise Active Directory
- Group Memberships
- Security Group Memberships
- Distribution List Memberships
- Microsoft 365 Groups Memberships Only defined in Hybrid (with Exchange Online Services) and Entra ID
- Entra ID Distribution List Memberships Only defined in Entra ID and Hybrid, when Exchange Online Services is configured
- Entra ID Security Groups Only defined in Hybrid (with Enable Entra ID Security Groups) and Entra ID
- Mail Enabled Security Group Memberships Only defined in Entra ID and Hybrid, when Exchange Online Services is configured
- Mailing List Assignment Provided in Google Directory
- Communication Hub
Deployment¶
Once your workflow has been setup, you can optionally setup notifications and archival for your workflow.
- Compliance and Audit Trail
- Run Mode
- Error Notifications
- Monitor Receipt of Scheduled HR Extract
- Environment
Otherwise, you can proceed to deploy and test it on the Hire2Retire platform, see Deploy and Test Flow