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 process detailed on the Onboard Portal Task page includes the ability to integrate iCIMS Onboard with a post-hire system.
What does the event do?:
The Onboard Portal Task event allows a recruiter to create a task with a dynamic re-direct to a third party post-employment system. 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 new hire should return to if the task is complete. |
| incompleteUrl | Portal Return URL | Specifies the URL on the Portal where the new hire should return to if the task is incomplete. |
| customerId | Customer ID | Specifies the ID of the customer |
| userId | New Hire System ID | Specifies the new hire 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 OnboardPortalTaskEvent. |
| systemId | New Hire System ID | Specifies the new hire who initiated the request |
Note: The incompleteUrl sends the new hire back to the Onboard Portal without marking the task as complete. The returnUrl does mark the task as complete.
The partner replies to the original request in Step 1 with any of the following HTTP Status Codes and the criteria for these responses:
- HTTP 303 See Other: The request was valid and was processed successfully; the link to complete the task 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 Web Services -> External Partner:
Connection: close
Link: http://test.icims.com/customers/1769/people/255;rel="user";title="User", https://test.icims.com/customers/1769/onboardworkflows/37532;rel="onboardWorkflow";title="Onboard Workflow", https://test.icims.com/customers/1769/newhirecategories/36705;rel="newHireCategory";title="New Hire Category", https://test.icims.com/customers/1769/jobs/4540;rel="job";title="Associated Job",
Content-Length: 218
Content-Type: application/json
Content-Encoding: gzip
Host: dummyserver.icims.com<br>
User-Agent: Apache-HttpClient/4.2.1 (java 1.5)
Accept-Encoding: gzip,deflate
{
"returnUrl": "https://onboarding-test.icims.com/onboard/task?task=607&hashed=1864849861",
"incompleteUrl": "https://onboarding-test.icims.com/onboard/task?task=607&hashed=1864849861",
"customerId": "1769",
"userId": "255",
"links": [
{
"title": "User",
"rel": "user",
"url": "http://test.icims.com/customers/1769/people/255"
}
{
"title": "Onboard Workflow",
"rel": "onboardWorkflow",
"url": "https://test.icims.com/customers/1769/onboardworkflows/37532"
}
{
"title": "New Hire Category",
"rel": "newHireCategory",
"url": "https://test.icims.com/customers/1769/newhirecategories/36705"
}
{
"title": "Associated Job",
"rel": "job",
"url": "https://test.icims.com/customers/1769/jobs/4540"
}
],
"eventType": "OnboardPortalTaskEvent",
"systemId": "255"
}
Use Cases:
Employment Eligibility Verification: I-9 & E-Verify
New hire’s Work Opportunity Tax Credit: WOTC
The Onboard Portal Task event is used by iCIMS to send Person data to a third party vendor. The event is triggered when an employee views a specified task on the Onboarding portal. This event is most commonly used by clients who use a third party for E-Verify verifications.