Product | iCIMS integration |
Expert(s) | Yi-An Lai (Enterprise EPD team) |
Slack channel | #icims-integration |
This article was last verified on | 04/11/2024 |
🔍 Articles in This Section
Please use the following list to see additional internal articles regarding the iCIMS integration:
- (Internal) iCIMS Integration Overview
- (Internal) iCIMS Integration Customer Eligibility and Setup (📍you are here)
Customer Eligibility and Prerequisites
The customer must use iCIMS as their ATS.
Setup
Here is a summary of the steps needed:
- Enable basic sync
- Enable deep sync
- Send the historical data export to engineering
- Deep sync begins
- Pipeline Stage Mapping
- Field mapping
1.Enable basic sync
[CSM] After the iCIMS customer is done with “BasicGem <> iCIMS IntegrationSetup”, enter their credentials in the iCIMS info tab of admin settings. Also make sure the “Sync enabled” radio button is on.

After this step you can onboard the customer to dedupe & upload.
2. Configure Deep Sync
[CSM] After the iCIMS customer finishes “Part A. Set up API access for the advanced integration”, enter the credentials in the iCIMS info tab of admin settings for the team. Use the “Test REST API & Data Stream API credentials” button in the admin configuration to confirm if the credentials are valid. Do NOT turn on the “Deep sync integration” at this stage. It will be enabled once engineering has imported historical data and field mappings in the later steps.


3.Send the historical data export to engineering
After the customer or their iCIMS contact shares the “historical data export” referenced in “Part B: Configure the sync” of the customer sync, create an Asana task and tag the oncall engineer. Sample ticket.
The data export info looks something like this:
Host: [sftp.icims.com](http://sftp.icims.com/)
username: customer5978
password: abcd123
port: 22
4.Field Mappingand custom fields
For field mapping… This is very similar to Success Factors field mapping. Both ATSes are very configurable. This means that customers can change standard field names - for e.g. they can rename the standard “recruiter” field on a Job to “coordinator”.
Field mapping is about mapping the customer’s field names to the standard iCIMS fields that Gem understands.
Engineering will provide a spreadsheet (sample) containing the standard field mappings configured for the team. After you have the spreadsheet, schedule a meeting with the customer and the engineer to validate the data we have synced to Gem from iCIMS and discuss any custom field requests.
5.Deep syncbegins
Make sure there is an Asana task with engineering. Once the field mapping is confirmed, engineering can kick off the deep sync.
Once kicked off should complete in about 1 week.
6.Pipeline Stage mapping
For pipeline stage mapping this should be similar to other ATSes. Some caveats:
- iCIMS doesn’t have stages. It has “statuses” and “status groups”. It’s most similar to SuccessFactors.
- NOTE: rejection reasons will appear as statuses. Remember that these shouldn’t be mapped as Gem stages.
- Customer Eligibility and Prerequisites
- Setup
- 1.Enable basic sync
- 2. Configure Deep Sync
- 3.Send the historical data export to engineering
- 4.Field Mappingand custom fields
- 5.Deep syncbegins
- 6.Pipeline Stage mapping