Developer Resources

Integrating with iCIMS: Getting Started

If you are planning to build an integration with multiple iCIMS clients' Platforms, you should review and follow the process outlined below:

  1. Review iCIMS Developer Resources site, developer.icims.com.

    1. Review iCIMS Standard Integration use cases and their workflows.
    2. Review the REST API, including:
      1. Connecting and Authenticating
      2. Object Types and Commands
      3. Integration Events
    3. Review iCIMS Data Models and determine the fields that your integration will read from and write to.
    4. Review iCIMS New User Resources to learn the iCIMS Talent Platform.

  2. After reviewing iCIMS API, design your integration to be standard (i.e., use the REST API and read/write to standard fields). Integrations should also be designed to be scalable and repeatable, meaning that they are easy to setup and require minimal back-and-forth between yourself, your client, and iCIMS staff.

  3. Once you have built a design for the integration, reach out to the iCIMS Developer Support Team to explain your business use case and value proposition for our shared clients. The Product Management team will review your business use case and answer any additional questions that you have.

  4. Once the Product Management team approves your integration request, iCIMS will set up a sandbox environment for you. [To set up a sandbox environment, iCIMS requires a REST endpoint and a list of IP addresses (belonging to the machines that will communicate with the REST endpoint in the sandbox environment) to allowlist.]

  5. Use the sandbox environment to develop and test the integration for the iCIMS Marketplace Validation, and direct any questions to iCIMS Developer Support Team.  The iCIMS Sandbox is prohibited for customer integration testing and customer demo usage, and is subject for partner removal.

  6. After your integration has been successfully developed, reach out again to iCIMS Developer Support Team, who will review and approve the integration. [For more information on the approval process for integrations, see the Integration Approval Process page.]