This article explains how clients can set up the Greenhouse integration with their Deel accounts.

Greenhouse is an applicant tracking software that companies use to post job listing, track applicants, review progress through the hiring process and make job offers. 

With the Greenhouse integration, clients can choose to “Hire through Deel” in order to pull all relevant details of a new employee from the Greenhouse platform to Deel.

To install integrations on Deel, you must have the correct Org Admin permissions.

In this article:

Generating API key on Greenhouse

Setting up the Integration on Deel

Setting up Webhooks

Before you begin:

You must be an Org Admin, IT Developer Admin, or Integrations Admin-People to set up this integration. 

To successfully install the integration you must generate an API key from your Greenhouse account.

Generating API key on Greenhouse

To get the API key, please follow these instructions:

✅ Step 1 – Click the⚙️ icon on the top-left of Greenhouse

✅ Step 2 – Select the dev center on the left-hand menu.

✅ Step 3 – Select API credential management

✅ Step 4 – Click Create New API Key and select Harvest for ‘API Type’ option

✅ Step 5 – Search for Deel in the Partner search and select Deel.

This will ensure the permissions Deel needs are automatically configured.

You must select Harvest as the API Type option in order to see Deel as an available partner option.

✅ Step 6 –  Click Manage Permissions.

You may also add an optional description.

You’ll now be able to copy your API key.

If you lose this key you’ll need to restart the process. Select I have stored the API Key.

✅ Step 7 – You will then see a screen with the default permissions pre-selected. Click ‘Save’ at the bottom.

✅ Step 8 – Paste the API Key into Deel

This should cause the Connect button to turn blue.

Click Connect to establish the connection. You may now continue with the integration set-up on Deel.

Setting up integration on Deel

✅ Step 1 – Connect to the Greenhouse integration

Select the App Store tab on your home page, and click Connect to Greenhouse.

✅ Step 2 – Enter the API key from Greenhouse

✅ Step 3 – Install custom fields in Greenhouse

When you connect and successfully authenticate, you can install custom fields so we know which candidates you want to hire and generate contracts using Deel.

✅ Step 4 – Enter field name and dropdown field options

You can copy-paste all the details needed to create the field from this screen into Greenhouse, following these instructions to create the custom field:

1) Click on the ⚙️ icon in the top-right of Greenhouse.

2) Click on ‘Custom Options’ in the left-hand menu

3) Under ‘Company Custom Fields’ click ‘Offers’.

4) Click ‘Add Field’ which will take you to a new screen.

Please make sure to use the exact wording for the field name and dropdown field options. This needs to be done before moving a candidate to the offer or hired stage.

5) In field name, enter exactly : ‘Hire remotely using Deel?’

Deel will validate that this exact name has been used. You might also want to add a helpful description. Coveniently copy the suggested text under 'Description' on this screen.

6) Under ‘Field Type’ choose the ‘Single select’ option.

7) In the ‘options’ box enter in the following options on separate lines: ‘Fixed Rate’, ‘Pay As You Go’, ‘Milestone’, ‘Deel Full-Time Employee’

 8) Click Save

9) Click  Validate & Continue in Deel.

If you have installed everything in Greenhouse correctly, you will go to the next step: webhooks.

The Greenhouse integration will automatically sync daily at 8am GMT.

It is possible to further customize this field. For example, you can make the field visible for only certain countries of employment. There is also an option to make the field mandatory for certain countries, if you know you will always use Deel to hire in those countries. You can contact Greenhouse support to learn more. 

How to set up Webhooks in Greenhouse

Webhook events that you create on Greenhouse is how we know about both new offers and amended offers for candidates that need to be hired using Deel.

You will need to create 3 different webhook events, copy-pasting both the 'Endpoint URL' and 'Secret key' that we provide.

These webhooks tell us about new offers, updated offers, and deleted offers so we can create and update Deel contracts accordingly.

Please follow these steps on Greenhouse:

1) Click on the ⚙️ icon in the top-right of Greenhouse.

2) Go into ‘Dev Center’ on the left-hand menu.

3) Click on ‘Web Hooks’ in the sub-menu and then click ‘Web Hooks’ again on the new screen.

4) Name the web hooks something memorable such as ‘Deel - Offer Updated’.

5) Create a webhook for ‘Offer Created’ and enter in the Endpoint URL and Secret key provided to you on this page.

6) Click ‘Create Web hook’.

You can go back into Deel and press the validate button to see if everything was correctly set up.

7) Create 2 other web hooks for ‘Offer Updated’ and ‘Offer Deleted’.

8) Click Validate Webhooks

You need all three webhooks validated in order to complete the setup

9) Click 'Complete Setup' and you are done!