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.

A candidate export integration utilizes a webhook 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 third-party software provider.

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

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 review the information provided, and reach out to you and your team and/or to your desired provider to setup a discovery call to discuss the possible integration.

Set Up the Integration

Once the your team or the third-party system has built to the JazzHR webhook, 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. The naming convention does not matter as long as it is unique and recognizable by your team.
    2. Integration [webhook] URL - Enter the webhook URL (or listening server) where JazzHR should send the candidate payload. This is provided by the partner software provider.
    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.



Who will build the integration between JazzHR and my desired system?
Either your own internal web development resources or the desired provider will build to the JazzHR webhook. JazzHR has built an extremely simple, scalable webhook that is easy for programmers and web developers to understand and build to.

Can the JazzHR team build the integration for us?
JazzHR recently partnered with a customizable API software provider to help build a bridge between JazzHR customer accounts, and their desired 3rd party provider. For more information, please fill out the form here, and mention that you would like more information about the API software provider.

Can I send more than one candidate at a time to the desired system?
No, at this time you can only send one candidate at a time to the webhook url. Please note that you can automate this process as mentioned in the Export a Candidate section above!

What fields are sent in the Candidate Export webhook?
You can view the comprehensive list of JazzHR fields sent via the webhook in the documentation here.


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