This guide walks you through the steps to gather the necessary information and configure your Greenhouse Recruiting organization for the purpose of creating an integration.
Before you begin, ensure that you have:
- Access to the Greenhouse Recruiting web interface
- Access to a Greenhouse Recruiting account with permission to manage all of the organization's API credentials
| Harvest v3 Permission | Purpose |
|---|---|
Users | Read data about users, activate users, and deactivate users |
- Log in to Greenhouse.
- Open Configure > Dev Center > API Credential Management.
- Click Create new API credentials.
- For API type, choose Harvest V3 (OAuth).
- Choose the appropriate partner or select a custom/unlisted integration, depending on your Greenhouse setup.
- Enter a description that identifies the Synqly integration.
- Save the credential.
- Copy the Client ID and Client Secret and store them securely.
- Open the credential's permissions or scopes settings and grant access according to the required permissions above.
- Save the credential permissions.
Leave User ID blank unless Greenhouse must treat the API calls as a specific human user.
- Leave blank (default): almost always. The Harvest v3 integration service user can read users and enable or disable them if it has the
Userspermission. - Set it: when Greenhouse must audit or authorize the calls as a specific person (compliance, “who disabled this user”, or the integration service user lacks access that a Site Admin has).
- Effect: API requests are attributed to that Greenhouse user. An invalid User ID fails Verify on User ID, not on URL.
- How to get it: open the user in Greenhouse and copy the numeric ID or the full URL (
https://app.greenhouse.io/account/users/12345). Both are accepted.
Create your integration by supplying the following configuration values.
| Integration Parameter | Description |
|---|---|
| Client ID | This is the Client ID generated from the steps above. |
| Client Secret | This is the Client Secret generated from the steps above. |
| User ID | Optional. Leave blank to use the credential's integration service user. Set it only if API requests must be attributed to a specific Greenhouse user. |