Skip to content
English - United Kingdom
Sign in
Contact us
  • There are no suggestions because the search field is empty.

Activate the Hire Intelligence integration

Task Type: Activation

Feature: API, Job Feed, Direct Apply, Disposition Feed

 

Set up the Hire Intelligence Integration

This integration allows Hire Intelligence to:

  • Receive client jobs via a structured job feed
  • Use Direct Apply to submit candidates with screening questions
  • Retrieve outcome data via a disposition feed to assess advert performance

Clients benefit from improved visibility of results and optimised spend across recruitment channels, especially in Care, Education and NHS sectors.

 

I want to:
  • Enable the Hire Intelligence feed for job data
  • Create and configure the Disposition Feed
  • Set up a dedicated API Hire Intelligence user and security role
  • Generate and securely issue API credentials to Hire Intelligence
Pre-requisites
  • Clients must have API access enabled
  • Clients must have Direct Apply enabled
To check API access:
  1. In Settings > System Users, search for users titled ‘API’ or similar
  2. Edit the API user and check:
    • Generate API Password tab is visible.
    • Last generated date/time indicates that the password has been shared.

 

  • If API Access has not yet been activated, raise a Service Task for Hire Intelligence API Activation.

 

Unlike client-facing API access, Hire Intelligence does not require a Partnership Agreement.   The integration is restricted to only the permissions required to support job posting, Direct Apply and application outcome tracking for Hire Intelligence.

 

Check if Direct Apply is enabled

 

In ATS Control > Integrations > Direct Apply

 

  • Check that Direct Apply Global Switch is enabled. 
Although most often used with Indeed, clients can opt to enable Direct Apply for alternative providers, whilst keeping Indeed applications re-direct only.  For this setup option Direct Apply Global Switch is enabled, but options within the Indeed Direct Apply are disabled.

 

Step 1: Create the Disposition Feed
  1. Go to ATS Control > Client > Disposition Data > Disposition Feeds
  2. Select Add New
  3. Name the feed e.g. HireIntelligence_Disposition
  4. Format: XML
  5. Set the Source to match the Apply URL tracking code – in this case: HireIntelligence
  6. Choose operator: = (% which means like)
  7. Click Save
  8. Copy the generated Identifier (GUID)
  9. Construct the feed URL:

 

https://<clienturl>/feed/data/disposition?identifier=<GUID>

  1. Visit the URL to check it is a valid URL

 

A valid feed with no disposition data looks like this:-

 

A valid feed with disposition data looks like this:

 

For further information and troubleshooting on Disposition Feeds, see this guide.

 

Step 2: Create API user and role
  1. Go to Security Roles
  2. Create a new Security Role, titled Hire Intelligence API Access
  3. Enable only the following Security Role options:

 

List all jobs = enabled

 

Jobs & Talent Pools

  1. Jobs (access)
  2. List Candidate (access, add, update)
  3. List Candidate – CV (access, add, update)

 

Then:

  1. Go to System Users
  2. Create a new user (e.g. Hire Intelligence API User)
  3. Assign the new Hire Intelligence API Security Role
  4. Set a long, random login password (not needed for access)

 

Step 5: Generate the API password

(before this step, API activation must be complete)

  1. Edit the new Hire Intelligence API user
  2. Go to Generate API Password tab
  3. Click Generate and copy the password
  4. Tick to agree to terms and select Save

Note: Generating a new API password invalidates the old one.

 

If you don’t see the Generate API Password tab, check Security Role > Settings >

 

Step 6: Send credentials securely to Hire Intelligence / Refer to David to complete

(BaseURL, ClientID and ClientSecret would have been created when the client first activated our API. If you do not have this information, refer the ticket to David to complete the following steps.)

 

1. Create a .txt file with:

  • BaseURL
  • ClientID
  • ClientSecret
  • Username
  • API Password

Save this file in a secure location while you complete the next steps.

 

2. Encrypt with 7-Zip:

  • Compress the .txt file to a .7z or .zip archive using 7-Zip.
  • Encryption method: AES-256.
  • Set a unique 20-character password generated from an approved secure password generator.

 

3. Email the encrypted file:

Email body:

Hi,

 

Please find attached API credentials for a new Jobtrain / Hire Intelligence client: <<INSERT CLIENT NAME>>.

 

Job Feed: <<clienturl>>/feed/HireIntelligence


Disposition Feed: https://<<clienturl>>/feed/data/disposition?identifier=<<GUID>>

 

The attached document is password protected. The password will be shared separately via SMS.

 

Many Thanks

Jobtrain

 

4. Share the password separately (SMS only)

  • Send the archive password to Rhys by SMS using the verified mobile number on record.
  • Only send the password once you have confirmed the recipient’s identity (e.g. by using a known, verified number).
  • Do not send the password by email or include it in any ticketing system.

 

5. Once the encrypted file has been sent, delete the original .txt file.

 

FAQs

 

Can we customise the disposition feed format or fields?
No. Disposition feeds are standardised across all clients.

Do we charge the client for this integration?
No — this is a referral-based integration, no API access fee applies.

What if the disposition feed returns no data?
Check that:

  • The Source value matches exactly
  • Applications were submitted using Direct Apply with that source
  • Status changes occurred on the previous day

 

How often is the disposition feed updated?
Daily at midnight. Only includes apps with status changes from the previous day.