How to get the workflow ID from an Onboard Portal Task
If I receive an Onboard Portal Task event notification and I need to access the applicants workflow to update WOTC results, how can I get the applicant workflow ID?
Submitted by
iCIMSUNIFIL on October 22, 2019
Permalink
Finding Applicant Workflow ID from Onboard Portal Task Event Not
(edited)
Last Updated: December 12, 2024, 6:31 PM
The POST you receive from the Onboard Portal Task even notification will include the new hire's system ID and the ID of the associated job.
Using the two IDs listed above, perform a POST query to obtain the Applicant Workflow ID:
Method: POST
URL: http://clientname.icims.com/api/rest/search/applicantworkflows/
Payload: {
"filters": [{
"name": "applicantworkflow.person.id",
"value": ["123"],
"operator": "="
}, {
"name": "applicantworkflow.job.id",
"value": ["1000"],
"operator": "="
}]
}
The payload in the 200 response to your request will provide the Applicant Workflow ID:
{"searchResults":[{"self":"https://api.icims.com/customers/7609/applicantworkflows/20101","id":20101}]}