Greenhouse Integration Setup
This article explains how to set up the Greenhouse integration, including creating Harvest V3 API credentials, configuring Greenhouse webhook events, and configuring your Greenhouse subdomain to enable direct links into your Greenhouse instance.
This route is for organizations using Ashby for Analytics only. For more on the Greenhouse migration for all-in-one organizations, see Greenhouse → Ashby Recruiting API MigrationGreenhouse → Ashby Recruiting API Migration Guide.
Step one: Configure Harvest V3 API credentials
To create your API credentials (also referred to as a Client ID and Client Secret pair) for the Greenhouse integration:
- In Greenhouse, click the Configure icon > Dev Center > API Credential Management.
- Click Create new API credentials.
- Fill in the fields:
- API type: Harvest V3 (OAuth)
- Description: Something identifiable, e.g., "Data Sync Integration" (do not include "Ashby" in the description).
- Proceed to the permissions/scopes screen.
Set the required scopes
Select read scopes on all objects. This grants "list" access, meaning Ashby can list data for each object.
You may see items such as:
- harvest:candidates:list
- harvest:applications:list
- harvest:notes:list
- harvest:application_stages:list
- ... (other endpoints)
Save the credential.
Copy the Client ID and Client Secret
After saving, Greenhouse displays your Client ID and Client Secret.
Step two: Set up Greenhouse webhooks
Configure your Greenhouse webhooks to capture certain events in real time, such as candidate stage transitions, hires, and various record deletions. For more on configuring webhooks, see Setting up Greenhouse WebhooksSetting up Greenhouse Web hooks.
Step three: Locate and configure your Greenhouse custom subdomain
Your Greenhouse instance may have a custom subdomain, such as your company name or one of Greenhouse's multiple servers.
To find your subdomain, log in to Greenhouse and view any candidate or job profile. Your URL has the form [subdomain].greenhouse.io/.... Once you have found your subdomain, enter it in the Subdomain field in your Admin > Integrations > Greenhouse settings.
After you update your subdomain, a View in Greenhouse button appears when you view a candidate profile. This links directly to your candidate profiles. Additionally, AlertsAlerts provide links to your candidate profiles for convenient access.
Step four: Enter your API credentials in Ashby
You can find your Greenhouse integration configuration in your admin section by navigating to Admin > Integrations > Greenhouse. This is where you enter your API credentials and subdomain.
- Client ID: Enter your client ID (or client key).
- Client Secret: Enter your generated client secret.
- Custom Subdomain: Enter your custom subdomain to enable linking directly to candidate profiles from Ashby.
Adding the API credentials initiates your initial data sync. After your initial data sync completes, regular syncs continue once per hour to automatically ingest new data and updates. Ashby displays the last successful sync time in your Ashby user's timezone.