Skip to main content

Authorization

Follow this guide to create a new Greenhouse Harvest credential that will allow Nexla to authenticate to and exchange data with your Greenhouse account.
grharvest_api_auth.png

Greenhouse Harvest

Prerequisites​

Before creating a Greenhouse Harvest credential, you need to obtain a Harvest API key from your Greenhouse account. The API key is required to authenticate with the Greenhouse Harvest API.

To obtain your Harvest API key, you need to have a Greenhouse account with admin access. Once you have access to your account, you can fetch your API key from your Greenhouse account in Configure >> Dev Center >> API Credential Management. The API key is used for Basic authentication, where the API key is sent as the username in the Authorization header for all API requests to the Greenhouse Harvest API. For detailed information about API key setup and authentication, refer to the Greenhouse Harvest API documentation.

Create a Greenhouse Harvest Credential​

  • To create a new Greenhouse Harvest credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Greenhouse Harvest

GreenhouseHarvestCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Basic Authentication​

Greenhouse Harvest uses Basic authentication, where the API key is sent as the username in the Authorization header. Basic authentication is a simple authentication scheme built into the HTTP protocol.

  1. Enter your Greenhouse Harvest API key in the Harvest API Key field. This is the API key you obtained from your Greenhouse account in Configure >> Dev Center >> API Credential Management. The API key is sent as the username in the Authorization header for all API requests to the Greenhouse Harvest API.

    Keep your API key secure and do not share it publicly. The API key provides access to your Greenhouse account data and should be treated as sensitive information. You can view and manage API keys in your Greenhouse account in Configure >> Dev Center >> API Credential Management. The API key is used for Basic authentication, where the API key is sent as the username in the Authorization header for all API requests to the Greenhouse Harvest API. For detailed information about obtaining and managing API keys, see the Greenhouse Harvest API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.