Building Candidate Export Integrations

Interested in linking JazzHR with another app or web service with whom we don't natively integrate?

Use our candidate export integration framework to securely send candidate data from JazzHR to another software (i.e. HRIS/payroll systems/background check or assessment providers). This framework also supports homegrown systems and generic task apps, like Zapier, and others.

Candidate export integrations use candidate webhooks to move candidate information from one app to another. Building a candidate export integration will require development participation from either an internal team and/or the third-party software provider.

Note also that our candidate export integration framework only currently supports the sending of candidate data from JazzHR, but does not support receiving any data from other apps or web services.

To start building and using a candidate export integration:

Engage the JazzHR Team

Fill out the following form to provide us with information on your desired integration:

We'll reach out them on your behalf and keep you posted on the integration's progress.

Set Up the Integration

Once the third-party system has built to the JazzHR API, head into JazzHR to set up this integration:

  1. Click Settings.
  2. Click Integrations.
  3. Scroll down to the "Candidate Export Integrations" block.
  4. Click Add Integration.
  5. Enter the following:
    1. Integration Name - This should be the name of the integration and will show up when exporting candidates. Example: Time Rack
    2. Integration [webhook] URL - Enter the webhook URL to where JazzHR should send the candidate payload.
    3. Secret Key - Used to hash the export payload and verify payload authenticity on the partner side
  6. Click Save.


Export a Candidate

Once the integration is connected, follow the steps below to trigger a candidate payload to the specified webhook URL. To export an individual candidate:

  1. Click Candidates.
  2. Search for the candidate who you'd like to export.
  3. Click on the drop-down menu located next to the candidate’s Workflow Status
  4. Click Export Candidate.
  5. Choose the Integration Name that you chose in setup.
  6. Click Export.


To add an export as a Workflow Helper:

  1. Click Settings.
  2. Click Workflows.
  3. Click into the Workflow to which you want to add this.
  4. Click Add next to the stage on which you want this associated.
  5. Select Send to [integration name] from the drop-down.


Was this article helpful?
1 out of 1 found this helpful