Documentation

Connect JazzHR

JazzHR needs three credentials rather than one: your own API key, and a pair of partner credentials that JazzHR issues rather than you. Ask for the pair before you start, because the connection won't save without them.

Before you start

  • Your API key. In JazzHR only super administrators, recruiting administrators and developers can see it.
  • Apply API credentials — a username and a password. JazzHR gives these to approved partners, not to customers, so you can't generate them yourself. Ask Voyse support to arrange them. Voyse uses them to read the full application form for a role, so candidates applying through Voyse answer the same questions they would on your JazzHR careers page.

Get your API key from JazzHR

  1. In JazzHR, select Settings in the top navigation, then Integrations.
  2. The first entry, with the JazzHR logo, has a field labelled API Key. Select GENERATE NEW KEY if it's empty.
  3. Copy the value.

The key belongs to the account that generated it, so use an account that will stay with the company rather than one likely to be deactivated.

Connect it in Voyse

  1. Select Integrations in the sidebar.
  2. Under Connect an ATS, choose JazzHR.
  3. Fill in API key, Apply API username and Apply API password.
  4. Select Connect. The pill by the provider's name reads Connected, and Sync status fills in once the first import finishes.

All three fields are required. If you have the API key but not the partner pair, the connection stops there rather than saving half of it.

Set up the candidate export

This is how a candidate moving stage in JazzHR reaches Voyse without waiting for the next day's import. Job changes always come from the import — JazzHR sends Voyse candidate activity, not job activity.

  1. On the Voyse Integrations page, copy the Webhook URL and the Secret key from the Webhooks section.
  2. In JazzHR, go to Settings → Integrations and scroll to the bottom, to Candidate Export Integrations.
  3. Select Add Integration, name it Voyse, paste the webhook URL, and paste the secret key as the signature key.
  4. Back in Voyse, Last webhook changes from Never the first time an export arrives.

What comes across

Roles that are open in JazzHR and neither private nor confidential. Departments are taken from the roles themselves, so a department with no open role won't appear.

Capabilities lists Job Sync, Application Submit and Webhook Events as essential — those work with the credentials above.

Candidate Notes is listed but stays Not granted, and selecting Check capabilities won't change it. JazzHR offers no way to confirm that a key may write notes without writing one, so Voyse doesn't claim the permission it can't verify. Nothing else is affected.

If it didn't work

  • The connection refuses with a message about the Apply API — one of the pair is missing or mistyped. Both are needed together.
  • Invalid JazzHR credentials — the API key has been regenerated in JazzHR, which retires the previous one. Copy the current value and connect again.
  • A role you can see in JazzHR never arrives — check it isn't marked private or confidential.

The rest of the page — sync status, the activity log, disconnecting — is covered in Connect your ATS.