Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Greenhouse

This documentation for the Greenhouse integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Greenhouse, visit our connection instructions.

Version

This integration utilizes the Greenhouse Harvest API v1.

Base URL

The base URL used for all Greenhouse API endpoints:
https://harvest.greenhouse.io/v1

Authentication & Authorization

The DataGrail Greenhouse integration connects using basic authentication which requires a Harvest API Key and Username.

Sensitive Credentials
Publicly exposing your API credentials can allow unauthorized access to Greenhouse API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Scopes

The Greenhouse integration requires specific scopes that must be granted in order to function for a given capability.

ScopeBaseAccessDeletion
Get: List Users
Get: List Candidates
Delete: Delete Candidate
Patch: Edit Candidate
Base Scopes
All base scopes must be granted in order to connect the integration with DataGrail. The remaining scopes are only required if enabling those capabilities

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:


Limits

Limits in Greenhouse are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

  • DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
  • DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

Capabilities

Access

DataGrail's Greenhouse integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

  1. Search for Candidates using the Data Subject email address.
  2. If a match is found, save the extracted candidate data in candidate_records, and then extract the candidate's applications to the separate apps_records collection.

Endpoints Utilized


Deletion

DataGrail's Greenhouse integration provides Synchronous Deletion capabilities for the following supported identifier category: Email. DataGrail supports two deletion modes: Deletion (Default) and Anonymization.

If you would like to change deletion modes, please contact support@datagrail.io.

Data Interactions

In Deletion mode, DataGrail will take the following actions for Deletion requests:

  1. Delete a candidate by their ID.

In Anonymization mode, DataGrail will take the following actions for Deletion requests:

  1. Update a candidate by their ID with the following anonymization rules:
Anonymization Rules

Set the following fields to null:

  • addresses
  • company
  • custom_fields
  • email_addresses
  • phone_numbers
  • social_media_addresses
  • tags
  • title
  • website_addresses

Replace the following fields with a random string:

  • first_name
  • last_name

Endpoints Utilized


 

Need help?
If you have any questions, please reach out to your dedicated CSM or contact us at support@datagrail.io.

Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.