• 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
  • Getting Started
  • API
  • Standard Integrations
  • Prime Integrations
  • Endpoints
  • Streaming Endpoints
  • Data Models
  • Integration Events
    • Best Practices
    • Application Complete
    • Job Edit
    • Job Posting
    • Job Unposting
    • Onboard Portal Task
    • Status Flow Update
  • OTHER TECHNOLOGY
  • FAQ

Application Complete

The Application Complete Event allows a client to initiate an integration with an iCIMS partner and the candidates that are applying to their requisitions.

What does the event do?: 

The Application Complete event was designed to fulfill a seamless application process and candidate experience.  Once a candidate has applied to a job where an event should be triggered, a communication from iCIMS to the Partner will be initiated when that candidate reached the end of the application process.  The Partner will have the ability to take that candidate to their environment and provide a return URL for that candidate to navigate back to the client's Career Portal.  The JSON payload of the POST contains the following variables:

Parameter iCIMS Field Mapping Purpose
returnUrl Portal Return URL Specifies the URL on the Portal where the candidate should return to finish the application process.
customerId Customer ID Specifies the ID of the customer
userId User System ID Specifies the candidate who initiated the request 
links GET Links Specifies the exact GET request necessary to return additional information for an entity.
eventType Event Type Specifies event type, which will be AssessmentEvent.
systemId Recruiting Workflow System ID Specifies the candidate and job relationship. 

The partner replies to the original request in Step 1 with any of the following HTTP Status Codes and the criteria:

  • HTTP 303 See Other: The request was valid and was processed successfully; the redirect link for the candidate is provided in the response header.
  • HTTP 400 Bad Request: The partner received an incorrect or malformed request, or is otherwise unable to service the request due to its contents.

Example:
 

iCIMS  -> Partner:

POST /rest/rest/echo HTTP/1.1
Connection: close
Link: https://api.icims.com/customers/1234/applicantworkflows/8702;rel="applicantWorkflow";title="Applicant Workflow",https://api.icims.com/customers/1234/jobs/2014;rel="job";title="Job Profile",https://api.icims.com/customers/1234/people/1417;rel="person";title="Person Profile",https://api.icims.com/customers/1234/people/1417;rel="user";title="Posting User",
Content-Length: 296
Content-Type: application/json
Content-Encoding: gzip
Host: dummyserver.icims.com
User-Agent: Apache-HttpClient/4.2.1 (java 1.5)
Accept-Encoding: gzip,deflate

{
    "returnUrl": "https://jobs-customername.icims.com/jobs/2014/customer-service-rep-1/assessment?i=1"
          "customerId": "1234",
           "userId": "1417",
           "links": [{,
             "title": "Applicant Workflow",
             "rel": "applicantWorkflow",
             "url": "https://api.icims.com/customers/1234/applicantworkflows/8702"
        },
        {
            "title": "Job Profile",
            "rel": "job",
            "url": "https://api.icims.com/customers/1234/jobs/2014"
        },
        {
            "title": "Person Profile",
            "rel": "person",
            "url": "https://api.icims.com/customers/1234/people/1417"
        },
        {
            "title": "Posting User",
            "rel": "user",
            "url": "https://api.icims.com/customers/1234/people/1417"
        }
    ],
    "eventType": "ApplicationCompletedEvent",
    "systemId": "8702"
}

Use Cases: 
Application Complete: Assessments & Tax Credits

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.

Assessments

Tax Credits

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