Integration Setup (Admin)
Before you begin, please ensure that you are...
-
A subscriber of hireEZ Enterprise and have a valid hireEZ account (*Please contact your hireEZ Account Manager if you need help setting up an Enterprise license).
-
The Admin user of your company's hireEZ Enterprise subscription
Note: Please do not connect your test/sandbox instance with the hireEZ production account. If you would like to perform sandbox testing, please reach out to support@hireez.com or the assigned TPM. They can assist you further to issue a separate instance for testing.
In case you end up connecting your sandbox account with the hireEZ production account, notify the support team at the earliest. This brings unknown issues for the integration and results in a delay in your onboarding.
Step 1: Get Import Service integration API credentials from Avature
-
Contact your Avature account manager/support to obtain import service integration API credentials.
-
API Key
-
Import Service URL
-
-
Once you receive API Key, add the authorization header X-Avature-Key in your browser to validate the token with the API Key (Contact your support at Avature for more info)
Step 2: Configure External Import Service in Avature
-
Configure External Import Service in Avature settings page
-
Create a new import service in the Avature settings page
-
Get the Avature generated endpoint URL
-
Avature External Import Service expects all candidates fields as ‘Comma Separated Value’ (CSV)
-
Define CSV layout
-
Indicate the first line as header (name of the columns)
-
Map candidates fields to “column”: Please find out CSV candidates fields layout send by hireEZ on the next page
-
Set content encoding to UTF-8 & Set column delimiter to “,”
-
-
-
Configure External Import Service in Avature settings page (CSV layout)
-
hireEZ will upload candidates information as a CSV file in the following column sequence
-
First Name, Last Name, Home Email, Extra Emails, Mobile Phone, Home City/Town, Home State, Home Country, Position Title, Position Employer, Position Role & Responsibilities, Position Start Date, Position End Date, School, Degree, Major, Education Start Date, Education End Date, LinkedIn URL, GitHub URL, Stack Overflow URL, Website, hireEZ URL, Notes, Tags, Added By, Source
-
-
Step 3: Configure Avature integration on hireEZ
- As an Admin user, you will be able to configure your ATS by clicking on the All Integrations tab.
-
If you also have an Enterprise team member license, you can configure it in hireEZ Apps by clicking here and follow the same instruction below.
-
You will see a pop-up window to input Avature API Key and URL

Step 4: You will receive both in-app and email notifications when you have successfully connected to Avature.
Export candidates from hireEZ to Avature
After you have found qualified candidates in hireEZ, you can easily export them into Avature.
-
Go to your hireEZ project pipeline, select the candidates and click Export.
-
You will receive both in-app and email notifications when the export is completed.
Customize Data Field Mapping (Admin Only)
If you want to customize the data field mapping:
- Select a hireEZ candidate profile field from the ‘hireEZ fields’ and choose a suitable field from the Avature profile fields dropdown.
After the ATS is successfully integrated, you may export the candidate's profile to the ATS.
Here is a guide on how to export candidates: How to Export Candidates to ATS, CSV, or PDF File.
For any other questions, please reach out to our Customer Success Team or email support@hireez.com.
Comments
0 comments
Please sign in to leave a comment.