Greenhouse
Greenhouse (opens in a new tab) allows you to programmatically add Greenhouse Recruiting users and manage their names, emails, or employment statuses to achieve parity with an outside system like an HRIS. This way you can add, deactivate, and update users at scale.
Prerequisites
In order to integrate with Greenhouse, you'll need to collect the following information:
NOTE You will need an API key for the Greenhouse Harvest API to use this integration. Harvest API keys can be obtained in Greenhouse. In order to create a Harvest API key, a user must be granted the “Can manage ALL organization’s API Credentials” in the “Developer permission” section. That user can then go Configure icon then choose Dev Center then API Credential Management. From there, you can create a Harvest API key and choose which endpoints it may access. In this case the key should be allowed for the Candidate endpoints Get: List Candidates and Put: Anonymize Candidate.
You will also need to provide a Greenhouse User account value. This value can be determined by logging into Greenhouse with the desired account. Once logged in; Click on the configure gear select users select the desired user to use, and make note of the URL, it will contain the ID of user to use. Any configured user's id can be used for this purpose, it will be added to the On-Behalf-Of header with the anonymize request.
Name | Description |
---|---|
Domain* | The Harvest API domain (default = harvest.greenhouse.io) |
Harvest API key* | Your Harvest API key. You can view and manage your API keys by clicking the gear icon from your Greenhouse landing page, then select the Dev Center link and finally you can select API Credential Management. |
Greenhouse User ID* | The user ID associated with the Greenhouse user account you wish to use, this account will be used in the On-Behalf-Of header for the anonymize endpoint, it is required for auditing purposes. Further details available in the Harvest API documentation here (opens in a new tab) |
Integrating with Greenhouse
To integrate an existing system with Greenhouse:
- Navigate to Data map → View Systems and choose the system that you want to connect.
- Click on the Integrations tab.
- Pick the vendor or system type that you want to integrate with from the Connection type drop-down menu.
- Complete the required fields for the integration and click Save.
You may confirm your connection is working using the Test connection button, if desired.
To learn more, please see our guide for Managing Integrations.
Technical detail
Fides utilizes API endpoints to access the API service for a SaaS application. An API service is the programmatic interface through which Fides can query and update data within an application to access, rectify, or delete personal information. Each SaaS tool will have a unique set of endpoints to enable privacy functions.
Greenhouse Harvest Endpoints
In the table below, you can find which endpoints are used for each type of privacy function. Clicking on the endpoint will take you to the documentation for that endpoint.
Privacy function | Endpoint | Description |
---|---|---|
Access Requests | List Candidates (opens in a new tab) | List all of an organization’s candidates. |
Update or Delete Requests | Anonymize Candidate (opens in a new tab) | Anonymize the data associated with a candidate. |
By default, deletion requests are fulfilled by masking personal information. To enable Fides to personal information, ensure the masking_strict
variable in your fides.toml
file is set to false
.