• iCIMS Corporate Site
  • iCIMS Partners
  • Additional Resources
  • Recent Updates
  • FAQ
  • Login
  • GETTING STARTED
    • Getting Started
    • Integration Approval Process
    • How-To Videos
    • Acceptable Use Policy
    • Terms of Use
    • Release Notes
  • API
    • Licenses
    • Connecting, Authenticating, and Identity
    • Authenticating API Calls with OAuth 2.0
    • HMAC
    • Error Handling
    • Error Reporting Standard for Vendors
    • Field Types
  • Standard Integrations
    • Assessments
    • Candidate Matching
    • Candidate Ranking
    • Document Management
    • Data Analytics and Reporting
    • Human Capital Management
    • I-9 & E-Verify
    • Job Advertising
    • Job Posting
    • Partner Screening
    • Reference Checks
    • Tax Credits
    • Video Interviewing
  • Prime Integrations
    • Prime Assessments
    • Prime Background Screen
      • Implementation
  • Endpoints
    • Binary Collection Fields
    • Binary Files
    • Collection Fields
    • Customers
    • Direct Linking
    • iForms
    • Job Distributor
    • Job Portal API
    • List API
    • Offer API
    • Onboard API
    • Profiles
    • Schema API
    • Search API
    • Workflows
  • Streaming Endpoints
  • Data Models
    • iForms
    • Job
    • Location
    • New Hire Category
    • Onboarding Workflow
    • Person
    • Recruiting Workflow
    • Room
    • Sourcing Workflow
    • Talent Pool
    • Event
    • Validation
  • Integration Events
    • Best Practices
    • Application Complete
    • Job Edit
    • Job Posting
    • Job Unposting
    • Onboard Portal Task
    • Status Flow Update
  • OTHER TECH
    • File-Based Transfers
      • Scheduled Import/Export Licenses
      • Imports
      • Exports
      • File Formatting
      • Import File Examples
    • SAML
    • Standard XML Feed for Job Boards
  • Forum

Search form

Developer Resources

Integration Events

Push events augment iCIMS API functionality with the ability to deliver real-time notifications to interested parties when important events take place within the Platform. This is opposed to a polling-based system where an external system must repeatedly query iCIMS API in order to determine if any changes have taken place. Instead, the Platform and iCIMS API will track these changes and send out notifications (as desired/configured) to indicate that changes have occurred.  

After logging in to the Platform, the system can be configured to deliver push notifications for a variety of different events that may occur within the Platform. To deliver these push events, the system must be configured through the Event Notifications page, where users include the URLs to push to.

Push events will be delivered via GZIP'd RESTful JSON over HTTPS through the POST method.

Partners are expected to reply with HTTP 200 OK if they successfully process the message without errors. Partners will be able to reply with HTTP 303 See Other in response to certain messages where link responses are required. Partners are expected to reply with HTTP 400 Bad Request if the message is malformed or otherwise incorrect.

Best Practices

The iCIMS Talent Acquisition Platform can generate real-time HTTP POST requests to an endpoint provided by a 3rd party for certain user actions. The endpoint should be designed to handle multiple customers and multiple event notification types to minimize the variability in the setup of the integration across multiple customers.

Learn More
Application Complete

The Application Complete event is used by iCIMS to send person and job data to a third party vendor once a candidate has completed the online application and filled out any other Screening or EEO questions on a client’s external Portal.  This event is most commonly used by clients who use a third party for Assessments or WOTC verifications.

Learn More
Job Edit

The Job Edit event is used by iCIMS to send updated job information to a third party vendor when a user has modified an externally posted job in the iCIMS Platform.  This event is most commonly used by iCIMS clients wishing to send jobs to third party aggregators.

Learn More
Job Posting

The Job Post event is used by iCIMS to send job information to a third party vendor when a user selects to post a job externally in the iCIMS Platform.  This event is most commonly used by iCIMS clients wishing to send jobs to third party aggregators.  

Learn More
Job Unposting

The Job Unpost event is used by iCIMS to send job information to a third party vendor when a user selects to un-post an externally posted job in the iCIMS Platform.  This event is most commonly used by iCIMS clients wishing to send jobs to third party aggregators.

Learn More
Onboard Portal Task

The Onboard Portal Task event is used by iCIMS to send Person and Job data to a third party vendor.   The event is triggered when an employee begins the verification process on their employee Portal.  This event is most commonly used for clients who use a third party for E-Verify verifications.

Learn More
Status Flow Update

The Status Flow update event is used by iCIMS to send person and job data to a third party vendor when an internal Platform user modifies a candidate’s status in the iCIMS platform.  This event is most commonly used by clients who use a third party Background Check provider, but can be used for other integrations as well.

Learn More
Do you have any questions or feedback regarding iCIMS' API documentation? Email the team
See Recent Site Updates

© 2023 iCIMS, Inc. All rights reserved.
Privacy Notice | Terms of Use