---
title: Setting up the Jobvite integration
slug: setting-up-the-jobvite-integration
docTags: 
createdAt: 2023-01-09T16:59:10.000Z
---

:::hint{type="info"}
[Packages](https://www.charthop.com/pricing/)**:&#x20;**<font color="#a9a9a9">Basic</font> <font color="#000000">|</font> <font color="#000000">**Standard*** | **Premium**</font>****

\* Available as an add-on
:::

This section covers the process of setting up your Jobvite integration app to begin migrating requisition data between Jobvite and ChartHop.

Setting up the Jobvite integration app requires the following steps:

1. Install the Jobvite integration app.
2. Create a Jobvite API Key/ Secret key and set up the flow of new hire data.
3. Set up the API connection.
4. Set up the flow of requisition data.

## Install the Jobvite Integration App

To connect Jobvite to ChartHop, you can install the Jobvite integration app in ChartHop.

 To install the Jobvite integration app:

1. From the left sidebar, select **Apps & Bundles**.
2. From the sub-menu, select **Apps**.
3. Select the **Availible Apps** tab.
4. Scroll the list down to the **Jobvite** app.
5. Select **Install**.
6. Select **Install** from the app install page.

## Create a Jobvite API and Secret key

In order to create an API and Secret key for your Jobvite integration, you need to send some specified information to your Jobvite representative.

| **Field**     | **Description**                                                                                                                                                                                        |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Webhook URL   | The URL that is automatically generated in the integration app page. <br /><br />You can get to this page by adding temporary values into the API Key and Secret Key fields as part of the setup flow. |
| Creator Email | The email tied to any actions performed through the integration. Any changes made by the integration will display as being made by this user in Jobvite.                                               |

### Create the Jobvite webhook 

To receive your Jobvite API key, you need to generate a web hook address and send it to your Jobvite representative.

To generate the webhook, complete the following steps:

1. Navigate to the Jobvite integration app. 
2. In the app’s **Settings&#x20;**&#x73;ection, enter the following:
   - A temporary value in th&#x65;**&#x20;API Key** field.
   - A temporary value in the **Secret Key** field.
   - Your **Creator Email**. 
3. Select **Save Settings**.

After you save the app’s settings, refresh the page. When the page refreshes, copy the newly created Webhook URL under the **Web Hook Setup** section in the app.

### Contact Jobvite representative

ChartHop partners with Jobvite for this integration, and so you'll need to work with your Jobvite representative to obtain the required Jobvite credentials.

After you generate your webhook url, send an email to your Jobvite CSM with your custom Webhook URL and Creator Email using the following template:

***

:::BlockQuote
*We are beginning our integration with ChartHop and need an API key generated for Charthop. (Please note that Charthop is a Jobvite partner)

The email I want to associate with the API activity is: \[Email]
&#x20;
In addition, please help set up a candidate hired webhook to the following URL: \[Webhook URL]

Please reply to this email with that information and ensure implementation\@charthop.com is included. ChartHop has previously integrated with the Jobvite APIs and is CC'ed as the technical contacts and can answer any questions.*
:::

***

:::hint{type="warning"}
Jobvite may require a zero dollar contract to be submitted in order to complete the API authorization request. Your Implementation Specialist can help you fill out and submit these forms.
:::

## Set up the API connection

Once you receive your API and Secret keys from Jobvite, enter your Jobvite API and Secret credentials in the **API Key** and **Secret Key** fields in the **Settings&#x20;**&#x73;ection of the app. Then, select **Save Settings**.

## Set up the flow of requisition data

Once you establish your API connection, you can configure the type of requisition data flow that the integration runs. 

### Select your source of truth

When setting up your integration, you can choose the primary source of truth when referencing new requisition data. Selecting ChartHop results in an outbound job data flow where ChartHop is the source of truth, whereas, selecting Remote System (Jobvite) results in an inbound job data flow where the ATS is the source of truth.

To select your **Jobvite** integration’s source of truth:

1. From the left sidebar, select **Apps & Bundles**.
2. From the sub-menu, select **Apps**.
3. Select the **Installed Apps** tab.
4. Scroll the list down to the **Jobvite** app.
5. Select the **Jobvite** app.
6. From the ChartHop **Jobvite** app settings page, scroll down to the **Source of Truth** section.
7. Select one of the two options:
   1. **ChartHop** - ChartHop is the source of truth and the integration is configured to run an outbound job data flow.
   2. **Remote System (Jobvite)** - Jobvite is the source of truth and the integration is configured to run an inbound job data flow.

### Configure the Jobvite Requisitions integration

You can configure the Jobvite integration app to handle two types of data migrations (job data flows) between ChartHop and Jobvite. Depending on the type of job data flow you choose, you may enable specific configurations that may either be required or optional but recommended.

These are the required and recommended configurations for each job data flow:

| **Job data flow type**        | **Configurations**                                                                                  |
| ----------------------------- | --------------------------------------------------------------------------------------------------- |
| Outbound, ChartHop to Jobvite | **Required** <br />* Sync On Change<br />**Recommended**   <br />* Run Daily                        |
| Inbound, Jobvite to ChartHop  | **Required**<br />* Reverse Sync<br />**Recommended**<br />* Run Daily
* Remote Location As Default |

To establish the configuration settings for your Jobvite Requisitions integration:

1. From the left sidebar, select **Apps & Bundles**.
2. From the sub-menu, select **Apps**.
3. Select the **Installed Apps** tab.
4. Scroll the list down to the **Jobvite** app.
5. Select the **Jobvite** app.
6. From the ChartHop **Jobvite** app settings page, scroll down to the **Other Options&#x20;**&#x73;ection.
7. Select from the following configuration options described in the table below.

After you select your integration’s source of truth, you can select additional options to further customize and configure it:

| **Field**                       | **Description**                                                                                                                                                                                                                                                                                                                  |
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Run Daily                       | With this option enabled, the ATS app runs automatically every day. When enabled, regardless of data direction, job-related candidate metrics are pulled on a daily basis every morning. For customers on the inbound job data flow direction, this also causes the inbound job data flow to run on a daily basis every morning. |
| Sync On Change                  | Enables the outbound job data data flow direction. When enabled, changes to open jobs are automatically pushed to Jobvite as soon as they are made in ChartHop. This option cannot be selected when **Reverse Sync** is enabled.                                                                                                 |
| Reverse Sync                    | When enabled, Jobvite becomes the system of record, and ChartHop is updated with new open roles from Jobvite when the inbound job data flow runs. This option cannot be selected when **Sync On Change** is enabled.                                                                                                             |
| Remote Location As Default      | When enabled, newly synced records that are not assigned a location are assigned the value **Remote Location**.                                                                                                                                                                                                                  |
| Publish Requisition On Creation | When enabled, open jobs that are pushed to Jobvite will automatically be published on career sites (both internal and external).                                                                                                                                                                                                 |

## Set up the flow of new hire data

You can use the new hire webhook job data flow to automatically bring new hires from Jobvite to ChartHop when the candidate is marked as “Filled” or “Offer Accepted” in Jobvite, along with their relevant personal information, such as address, phone number, and email.

The new hire webhook will be added to your integration at the same time as when you contact your Jobvite CSM  for the  API and Secret keys, as part of the same email request. Likewise, you will need to contact your Jobvite CSM if you wish to have your Webhook access removed in the future.

:::hint{type="info"}
In order to process the new hire in Charthop, the candidate must have an email address in Jobvite.
:::

New hire webhooks will not be processed if the person being hired already exists in ChartHop, even if they aren’t actively in a role. As a result, the integration cannot support:

- Internal transfers
- Re-hires

Only the first new hire webhook for a ChartHop job is supported. For example, if you update an offer packet and re-hire the candidate in Jobvite, the updated information will not be processed in ChartHop unless the new hire in ChartHop is removed first.

A new hire webhook will not be processed if the job does not exist in ChartHop.

