Setup Steps
DLH.io Setup Guide for iCIMS
Connector Pre-Requisites
This connector synchronizes iCIMS people with their phones and addresses, jobs, applicant workflows with their status history, source workflows, companies with their addresses, talent pools and the nodes of your custom lists. Before you begin, make sure that you have:
- The Client ID and Client Secret of an iCIMS API integration (OAuth 2.0 client credentials). Request one from your iCIMS integration specialist, with read access to people, jobs, workflows, companies, talent pools and lists.
- Your iCIMS Customer ID, the number that appears in your API addresses (
api.icims.com/customers/1234/...). - The Region your integration was issued in: US, CA or EU.
- If iCIMS restricts your integration to certain IP addresses, the DLH.io IP addresses added to that allowlist. Otherwise iCIMS refuses the calls with error 26.
Instructions (Basic Connection Setup)
DLH.io connects to iCIMS over secure channels using your API integration. This connection is read only and never writes data back to iCIMS.
- Enter a Name or Alias for this connection, in the 'Name/Alias' field, that is unique from other connectors.
- Enter in the 'Target Schema Prefix' field, a name that will be unique in your target destination where you wish to land the data.
- Enter the Client ID and Client Secret.
- Enter the Customer ID and choose the Region.
- Optionally set a Historical Start Date on the connection details. Without one, the first synchronization reads the records changed in the last two years.
- Click Save & Test to validate the connection.
- Optionally, list your own iCIMS fields (for example
field12345) in the iCIMS Custom Fields card on the connection's Configurations tab. Their values land in theCUSTOM_FIELDScolumn of each table.
How Data Is Synchronized
iCIMS returns records one at a time, so each synchronization costs one API call per changed record. iCIMS gives your company a daily allowance of API calls (10,000 by default) shared with all your other integrations, so DLH.io stops once 40% of the allowance remains and the next synchronization continues where it stopped. A first synchronization of a large account can therefore take several days to complete; ask iCIMS for a higher daily allowance to shorten it, and DLH.io uses it automatically.
People, jobs, applicant workflows, source workflows and companies are read by their last update, so later synchronizations read only what changed. Talent pools and custom lists are read in full every time. Only the top level of each custom list is read. Status history holds the 100 most recent changes iCIMS keeps per workflow. Dates are loaded as shown by iCIMS, without a time zone. iCIMS does not report deleted records, so a record deleted in iCIMS stays in your destination until a historical re-sync.