✅ 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 the admin section on AshbyHQ application.

✅ Step 2 - Navigate to Integrations > 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 - Give the following required scopes to your API keys:

✅ Step 6 - Copy the API key provided by AshbyHQ and paste it into the API Key field on the Deel platform.

Then click connect.

Please note that once the API Key is copied and the window is closed, it won't be possible to go back and copy the same API Key again.

If the API key is correct, the next steps will be to begin configuring custom fields.

Return and come back to the setup at a later point once an initial connection is established, in case the assistance of colleagues is needed. Simply press exit in top-right and then select Yes, Save And Leave. Enter the Ashby integration to begin where it was left off.

Create Webhooks

The integration relies on Webhook events being set up in an ATS to let Deel know when an offer has been created, updated or deleted.

Go into your ATS and set up 3 types of Webhooks.

At stage 2 of the setup process, the types of Webhooks needed will be visible, 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 Ashby application

✅Step 2 -- On the left menu, click on Ashby API section and select Webhooks

✅Step 3 - Click on the "NEW" purple button and use the data below to create the Webhook. Create 3 different Webhooks.

• Offer Created" will allow Deel to know when an offer to a candidate is created.
• Offer Updated" will allow Deel to sync the data of an offer in case it is changed.
• Offer Deleted" will allow Deel to remove the offer if deleted on Ashby.

For creating each one, 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 proceed to basic settings.

If there are any issues with webhooks at this stage, contact support representative at Ashby.

Basic Settings

These are the minimum settings needed for the integration with Ashby to be set up. Once the integration is complete, configure additional settings, such as custom field mappings and automation rules.

Choose at what offer stage to sync the candidate to Deel and complete setup.

Manage Integration

Once the integration is completed, customize it by clicking on 'Manage' on the Ashby homepage.

Deel has already pre-set most of the integration mapping & configuration settings. Any additional information to be added to the contract can be added by selecting 'Customize' for the necessary option.