---
title: "Connect iCIMS"
description: "Connect iCIMS"
canonical_url: "https://support.pave.com/articles/connect-icims-noNd39MCvJ"
md_url: "https://support.pave.com/articles/connect-icims-noNd39MCvJ.md"
---
# Connect iCIMS

iCIMS is an ATS integration that syncs candidate, offer, and compensation data to Pave using API credentials provisioned by iCIMS. Pave can also receive real-time offer status updates through webhooks.

## Before you connect

* iCIMS provisions the API credentials Pave uses. You cannot generate them from your own iCIMS admin settings, so you need to request them from your iCIMS representative.
* iCIMS sends you three values that you enter in Pave: a **Customer ID**, a **Client ID**, and a **Client Secret**.

## Connect iCIMS to Pave


1. Ask your iCIMS representative to provision **OAuth 2.0 REST API access** for Pave.
   * iCIMS provisions these credentials. They cannot be generated from your own iCIMS admin settings.
2. iCIMS sends you three values:
   * **Customer ID**
   * **Client ID**
   * **Client Secret**
3. In Pave, go to **Connections** and find iCIMS. Enter all three values and click **Submit**.

### Set up webhooks for real-time offer updates

After you submit, set up webhooks for real-time offer updates. Without webhooks, Pave picks up offer changes on its hourly sync.


1. Ask your iCIMS representative to send webhooks to **https://webhooks.pave.com/icims**.
2. Send your Pave CSE these iCIMS values:
   * **Username**
   * **Customer ID**
   * **Signing Secret** (HMAC format)

Once webhooks are set up, iCIMS notifies Pave when an offer's status changes, and Pave updates that offer without waiting for the next hourly sync.

## Troubleshooting

**Connection shows an error after you submit:** Pave checks your credentials by running a sync as soon as you click **Submit**. If the check fails, the connection shows an error. Confirm that the Customer ID, Client ID, and Client Secret match the values iCIMS sent, then re-enter them and click **Resolve**.

**No offers appear after connecting:** The iCIMS API access for Pave needs permission to read your offer and candidate data. Ask your iCIMS representative to confirm that the Client ID is linked to an API Integration User with access to that data.

**Some candidates or offers are missing:** Pave excludes an offer from the sync if:

* The candidate has no valid email address.
* The offer has no compensation (salary, bonus, or relocation bonus).
* The offer is not in a synced status. By default, Pave syncs offers that are in Launch Offer Approval or that have been extended, accepted, declined, or rescinded. Your account may be configured to sync a different set of statuses.

Pave also keeps one offer per candidate email address. If a candidate has more than one offer in iCIMS, Pave keeps the most recently updated one.

**Salary is missing from an offer:** Pave converts yearly, hourly, weekly, and monthly offer amounts to an annual salary. Offer amounts entered with any other pay rate (for example, daily) do not sync as salary. If the offer also has no bonus or relocation bonus, the whole offer is excluded because it has no compensation.

## After you connect

* The first sync brings in offers that were updated in iCIMS in the last 30 days. Offers that have not changed in that time do not sync.
* After the first sync, Pave syncs iCIMS data every hour.
* iCIMS limits how many API requests Pave can make each day. If a sync gets close to that limit, Pave stops early and continues syncing after the limit resets.

## Fields that sync

Custom mappings may apply to your account.

**Candidate fields**

* Email address
* First name, last name

**Offer and job fields**

* Offer status
* Offer date
* Start date (proposed start date)
* Job title
* Department
* Job code (job number)
* City, state, country
* Recruiter name, recruiter email
* Hiring manager name, hiring manager email
* FLSA exempt status
* Hourly or salaried

**Compensation fields**

* Salary (base pay), converted to an annual amount
* Bonus
* Relocation bonus
* Currency

### Additional data

* **Custom fields**: Supported. Pave can sync additional fields from iCIMS candidate, job, offer, and organization data. Contact Pave to configure custom field mappings.
* **Equity**: Can be synced through a custom field mapping.
