Greenhouse
This connector captures data from Greenhouse into Flow collections.
It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-greenhouse:dev
provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.
This connector is based on an open-source connector from a third party, with modifications for performance in the Flow system.
You can find their documentation here, but keep in mind that the two versions may be significantly different.
Supported data resources
The following data resources are supported through the Greenhouse APIs:
- Activity Feed
- Applications
- Applications Interviews
- Approvals
- Candidates
- Close Reasons
- Custom Fields
- Degrees
- Departments
- Disciplines
- EEOC
- Email Templates
- Interviews
- Job Posts
- Job Stages
- Jobs
- Job Openings
- Jobs Stages
- Offers
- Offices
- Prospect Pools
- Rejection Reasons
- Schools
- Scorecards
- Sources
- Tags
- Users
- User Permissions
- User Roles
By default, each resource is mapped to a Flow collection through a separate binding.
Prerequisites
- To set up the Greenhouse source connector, you'll need the Harvest API key with permissions to the resources Estuary Flow should be able to access.
Configuration
You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the Greenhouse source connector.
Properties
Endpoint
Property | Title | Description | Type | Required/Default |
---|---|---|---|---|
/apikey | API Key | The value of the Greenhouse API Key generated. | string | Required |
Bindings
Property | Title | Description | Type | Required/Default |
---|---|---|---|---|
/stream | Stream | Resource of your Greenhouse project from which collections are captured. | string | Required |
/syncMode | Sync Mode | Connection method. | string | Required |
Sample
captures:
${PREFIX}/${CAPTURE_NAME}:
endpoint:
connector:
image: ghcr.io/estuary/source-greenhouse:dev
config:
apikey: <secret>
bindings:
- resource:
stream: applications
syncMode: full_refresh
target: ${PREFIX}/applications
{...}