# Greenhouse
Greenhouse (opens new window) is an applicant tracking system and recruiting software that is designed to help make companies great at hiring and hire for what's next.
Workato's Greenhouse connector enables you to build even more automation around applicant and candidate workflow and connect with other human resource management systems.
# API version
The Greenhouse connector uses the Greenhouse Harvest API v1 (opens new window).
# How to connect to Greenhouse on Workato
Create a Workato connection to your Greenhouse instance using API token credentials.
# API token credentials
Use API token credentials to allow Workato access to your Greenhouse instance.
Authentication using API token credentials
Connection field | Description |
---|---|
Connection name | Provide a unique name that identifies which Greenhouse instance it is connected to. |
API key | The API token credential. Learn how to create an API key below. |
User email | The user email this API token is generated from. |
Environment | Use the drop-down menu to select a default domain (sandbox or production) or to provide a custom domain. If you leave this field blank, it defaults to production. |
# How to create an API token for Workato
We recommended using an Integration System User (ISU) for integration with Workato. This ensures that permissions are consistent and all operations can be logged on a single account.
Navigate to Settings > Dev Center > API Credential Management.
Greenhouse API credentials
Select Harvest to create a new API key for Workato.
Create an API credential for Workato
Provide the necessary permissions for this API key.
Select API credential permissions
PERMISSIONS
Ensure that you give this API credential the necessary permissions. If permissions are not configure correctly, certain Greenhouse connector actions and triggers may not work as intended even if the connection is successful. Refer to required permissions for more information.
# Permissions for Harvest API
The Greenhouse connector requires an API key with permissions to access specific Greenhouse objects. For example, the reject application action requires the Applications permission.
# List of Greenhouse Harvest API permissions
- ✅ Applications
- ✅ Candidates
- ✅ Education
- ✅ Jobs
- ✅ Scheduled Interviews
- ✅ Users
You can view and manage the permissions for each API key in the API Credential Management page.
Manage API credential permissions
Last updated: 5/17/2024, 2:35:03 AM