Skip to main content

Connect Carerix to Hyre

Connect Carerix with an API client with the right scope, your realm and client ID and secret. Plus what Hyre writes to Carerix.

Written by Wijnand Karsens

For Carerix, your Carerix admin creates an API client. With the client ID, the secret and your realm you then connect Carerix in Hyre yourself.

Before you start

  • You have a Carerix admin who can create API clients. Sometimes Carerix itself has to switch something on; this can take a few days.

  • All users who work with Carerix are in the same Hyre organization.

Step by step

1. Create an API client in Carerix (Carerix admin)

  1. In Carerix, go to Maintenance › Identity Access › Clients and click New.

  2. Give the client a recognisable name, for example "Hyre API".

  3. Choose the type Confidential.

  4. Set the default scope to urn:cx/cx5Wrapper:data:manage. Without this scope every request fails.

  5. Set Active to Yes and save.

  6. Copy the Client ID and the Client Secret, without spaces before or after.

  7. Find your realm: open the OpenID Configuration link. The realm is the word right after /realms/ in that link.

2. Connect Carerix in Hyre

  1. Go to Settings › Integrations, find Carerix and click Connect.

    The Integrations page in Hyre

  2. Fill in the client ID, client secret and realm, and confirm.

  3. Owner or admin: make Carerix the write target. Do this for ATS and CRM (⋯ › Make ATS write target and Make CRM write target). If Carerix isn't also your CRM write target, Hyre doesn't write contact persons.

  4. In Carerix, create a long text field Hyre profile, then click Refresh in Hyre under Settings › Fields.

What Hyre writes to Carerix

  • One activity per conversation for the candidate and the contact person together, and one more for each further person.

  • A meeting or intake with a start and end time becomes a meeting with its location. Everything else, a phone call included, becomes a note.

  • Hyre picks the activity type from your own Carerix list that fits the kind of conversation, so your Carerix dashboards count it.

  • The activity is linked to the job and the application when you name them, and for a contact person to the company.

  • Hyre doesn't write email conversations to Carerix. Carerix syncs mail itself.

Good to know

  • Card says "Needs attention"? Click Reconnect. If that doesn't help, have an owner or admin remove the connection (⋯ › Disconnect) and connect again with Connect.

  • Error when connecting while everything looks right? Check the scope (step 4) and that there is no space in the client ID or secret. Still stuck? Send us a message through Helpdesk, without the secret.

  • AI write limit. Hyre reads Carerix through the same route it writes through. So for Carerix, searches through your AI assistant also count toward the daily limit of 50 writes for Employees. If a colleague hits it, an owner, admin or manager can switch the limit off under Settings › AI write limit.

  • Notes land under the recruiter's name when their email address in Carerix matches their Hyre login.

Read the lesson

Video: Integration in the Hyre Academy, Admin setup chapter (Dutch).

Related

Did this answer your question?
Hyre Ai Help Center