Greenhouse walkthrough
The Greenhouse source connector allows you to pull recruitment and talent acquisition data from the Greenhouse API into your destination.
Prerequisites
- An active Greenhouse connection.
- Ensure your Greenhouse API key has read permissions for the specific resources you intend to sync.
Supported reports (Streams)
The Greenhouse connector supports the following data streams:
- Activity Feed
- Applications
- Candidates
- Custom Fields
- EEOC
- Jobs
- Job Openings
- Job Stages
- Offers
- Rejected Reasons
- Sources
- Scheduled Interviews
- Scorecards
Procedure
Configuring the source
Follow these steps to configure your Greenhouse data stream:
- Navigate to the Data Integration Console.
- Click + Create River from the top right-hand corner.
- Choose Source to Target River as your river type.
- In the Search tab, enter Greenhouse and select it.
- Define a Greenhouse connection or select an existing one.
- Select the report: Choose the desired data stream from the Report dropdown menu.
- Apply optional status filters: For reports that support status-based filtering such as Jobs or Applications, you can define the scope of your data:
- Click the Status dropdown and select the relevant states: Closed, Open, or Draft.
- Leaving this field empty returns all records regardless of their current state.
- Define the incremental logic: Specify the timestamp field the connector should use to identify new or modified data:
- Time_field:
- Created: Syncs records based on their initial creation date.
- Updated: Syncs records based on their last modification date.
- Configure the time period: Define the window of time for which data should be extracted:
tip
Applications report: If you select this report, you can adjust the Incremental type to either Created Date (filters by initial creation) or Last Activity (filters by the
last_activity_attimestamp).- Select time period: Choose Date Range or a Predefined Date. For example, Yesterday, Last Week.
- Set dates: Enter a Start Date. If the End Date is left empty, the system pulls data up to the current run time.
- Last Days Back For Each Run: Enter a value, for example,
2to expand the start date back by a specific number of days. This captures the records modified shortly after your last successful sync.
- Optimize with data chunking: For high-volume reports or periods longer than 30 days, use chunking to ensure stable data transfer and avoid API timeouts.
- Split Your Chunks By: Choose an interval (Daily, Weekly, or Monthly).
- Interval Size: Define the frequency. For example, choosing Daily with an interval of
2pulls data in 48-hour increments.
- Apply optional status filters: For reports that support status-based filtering such as Jobs or Applications, you can define the scope of your data:
Troubleshooting and tips
If you encounter an error during Automapping or while running the river, verify your Greenhouse API key permissions. Each endpoint, for example, /applications must be explicitly enabled for Read access in the Greenhouse settings.
When performing a large historical load, for example, several years of data, set Split Your Chunks By to Monthly and Interval Size to 1. This breaks the request into smaller pieces that the Greenhouse API can process more reliably.