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.
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.
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.
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.
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.
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.
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.
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.