Connecting, testing and resetting an integration
Enter a provider's details, test the connection, switch it on, clear an error or reset it from the Integrations page.
Enter a provider's details, test the connection, switch it on, clear an error or reset it from the Integrations page.
This is for System Admins. Only they can open Settings, then Integrations, and only they can save, test, reset or switch a provider. If your account belongs to a group of companies, pick the company in the selector beside the page title first, because everything you change applies to that company. Have the provider's details to hand. What each job board asks for is in "Job board connection details by board".
What each card shows
- The provider name. Boards that cost nothing to post to carry a Free badge: Indeed (Direct API), LinkedIn Limited, Adzuna and GOV.UK Find a Job.
- A status badge: Pending, Configured or Error.
- A last tested date and time once you have run a test.
- Configure, which becomes Manage once details are saved. Providers with nothing to enter have no such button.
- Reset, once the provider is Configured.
- Test Connection and an on/off switch.
If the page cannot load you see Couldn't load integrations with a Try again button. The page refreshes itself every minute, so a status change made in the background shows up without a reload.
Connecting a provider
- Go to Settings, then Integrations, and find the provider's card.
- Select Configure. A dialog titled for the provider opens.
- Fill in the fields. Save Configuration stays greyed out until every field passes its check. The checks are: “This field is required”, “Please enter a valid URL”, “URL must start with https://”, “Please enter a valid email address” and “Please enter a numeric value”.
- Select Save Configuration. You see “Configuration saved successfully”, the dialog closes and the badge changes to Configured. The first save also switches the provider on, so you do not need to touch the switch afterwards.
- Select Test Connection. The result reads Connection successful, or Connection failed followed by the reason.
Passwords, keys and tokens are hidden as you type. Use the eye icon (Show field value) to check what you entered. After saving, a secret is shown only in part: the first three and last three characters with dots between them, or dots alone when the value is short. Leave that text as it is to keep the saved value, or type over it to replace it.
Test Connection is greyed out until details are saved, with the hint “Save credentials first to test the connection”. For most boards the test signs in with your saved details. For a few connections, including iTrent, TotalJobs, CharityJob and GOV.UK Find a Job, Recruit has no live check to run. The test then confirms that every required field is filled and reports “Configuration validated (no live connection test available)”. If a required field is empty, the result reads “Missing required fields:” followed by the names.
To change details later, select Manage, edit the fields and save again.
Status badges and connection errors
- Pending: no details have been saved yet.
- Configured: details are saved.
- Error: Recruit tried to send jobs to the board and the board rejected the details, or they were missing. A message reads “[Provider] integration is reporting errors” and explains that postings are paused until the next successful attempt.
To clear an Error, select Manage, correct the details and save, then select Test Connection to see the underlying reason if it still fails. When the next delivery succeeds the badge returns to Configured and a message reads “[Provider] integration is working again”. Paused postings resume on the next delivery run. Postings that failed in the meantime can be retried from the Job Boards page, which is covered in "Troubleshooting failed job board postings".
Switching a provider on or off
The switch on each card controls whether Recruit uses the connection. A board that is switched off, or is still Pending, does not appear as a choice when a job is published. Switching it back on restores it.
If you switch on a board that needs details you have not saved yet, Failed to update integration appears and the switch returns to off. Use Configure first.
Adzuna and GOV.UK Find a Job have nothing to enter and need only the switch. Indeed needs only the switch too, and has optional settings.
Resetting a provider
Select Reset on a Configured card and confirm in the Reset Integration Configuration dialog by selecting Reset Configuration. This deletes every detail you saved for that provider and cannot be undone. The card goes back to Pending and you must enter the details again. Anything HireRoad manages centrally for that provider is restored automatically. You see “Configuration has been reset”.
If something goes wrong
- Failed to save integration: the dialog stays open with your entries intact and gives a reason underneath. Correct it and save again.
- Connection failed: read the reason shown with it. “Missing required fields” means open Manage and complete them. A message that the credentials were rejected means the board does not accept what is saved, so check them with the board.
- A board is missing when you publish a job: its card is still Pending, or its switch is off.
- The badge shows Error: see the section on status badges above.
- Reset removed something you needed: enter the details again with Configure. Saved details cannot be recovered.