This article explains how clients can set up the Ashby integration on Deel.
The Ashby integration will automatically sync daily at 5am GMT.
In this article:
How to set up the Ashby integration
Configuring Deel custom fields
Setting up the Ashby Integration
✅ Step 1 - Connect to Ashby
Select the Apps & Integrations tab on your home page, select Ashby, and click Connect the navigation menu.
You must be an Org Admin, IT Developer Admin, or Integrations Admin-People to set up this integration.
✅ Step 2 - Enter API key
To begin the set up, you will need a valid API key from Ashby.
Please follow the instructions below to see how this is done in Ashby.
Accessing API Key in Ashby
✅ Step 1 - Go to your admin section on your AshbyHQ application.
✅ Step 2 - On the left menu, click on Ashby API and select API Keys.
✅ Step 3 - Click on New purple button.
✅ Step 4 - Type a name for this key (this can be anything you want it to be) and click on Create API Key.
✅ Step 5 - Copy the API key provided by AshbyHQ and paste it into the API Key field on the Deel platform.
Then click connect.
If the API key is correct, you will proceed to the next step and begin configuring custom fields.
You can return and come back to the setup at a later point once you have established an initial connection in case you need the assistance of your colleagues. Simply press exit in top-right and then select Yes, Save And Leave. When you enter the Ashby integration you will begin where you left off.
Configuring Deel Custom fields needed for the integration
In order for your integration to work you will need to configure a custom field on the offer within Ashby's admin settings.
You can see details about the field and field options you need to install on the setup flow and copy-paste them into Asbhy.
✅ Step 1 - Return to admin section on the Ashby application
✅ Step 2 - On the left menu, click Organization Fields and select Custom fields
✅Step 3 - Click new in top-right, select object type 'offer' and name the field: “Hire remotely using Deel?”.
We suggest adding a helpful description for your colleagues, too, who might not know about Deel.
✅Step 4 - Choose the Field Type Multiple Choice and define the following values that correspond to Deel contract types:
- EOR Employee
- Fixed Rate
- Pay As You Go
- Milestone
This screenshot demonstrates exactly how to configure the custom field.
✅ Step 5 - Click Create
You can make the field mandatory or not depending on whether you plan on hiring everyone in your company using Deel.
Please note that you need to follow the wording (not case sensitive) exactly to proceed to the next step in the setup process.
✅ Step 6 - Click Validate & Continue on Deel
We will validate that the field is there and configured correctly.
Create webhooks
The integration relies on webhook events being set up in your ATS to let us know when an offer has been created, updated or deleted.
Therefore, you will need to go into your ATS and set up 3 types of webhooks.
At stage 3 of the setup process, you will see clearly the type of webhooks you need, as well as the Request URL and Secret Token needed for creating all 3 of these webhooks.
✅ Step 1 - Go to the admin section in your Ashby application
✅Step 2 -- On the left menu, click on Ashby API section and select Webhooks
Please note that webhooks might be hard to see because it is covered by an "?" icon as you see from the above screenshot.
✅Step 3 - Click on the "NEW" purple button and use the data below to create the webhook. You need to create 3 different webhooks.
- Offer Created" will allow us to know when you create an offer to a candidate.
- Offer Updated" will allow us to sync the data of an offer in case you change it.
- Offer Deleted" will allow us to remove the offer from our system if you delete it on Ashby.
For creating each one you will need to copy-paste from Deel Request URL and Secret Token for the integration which you can find easily on the setup screen.
✅ Step 4 - Click Validate Webhooks and then click complete setup
If you experience any issues with webhooks at this stage we ask that you contact your support representative at Ashby.