When using the 'update' API for a change to the manager or employee that no longer meets the criteria set on the workflows (i.e. they are moving to another part of the business where we don't have a workflow built), we'd like for them to be terminated out of Enboarder and not continue on the journey attached to their past role. How can we make this happen?
It has to be handled separately for Employee and Manager
Employee moving to different business unit: They should cancel the workflow. As the onboarding journey is related to this employee. Using the cancel api instead of update api
Manager moving to different unit: Workflow continues for Employee, but manager of employee changes, so update api to change the manager on workflow should be called.
How we can invoke Bulk rest API, What is its URL and sample payload?
It is a POST request with url as https://<serverurl>/restapi/v1/startwf/bulkadvance with body as the json payload along with apikey header.
Sample Payload:
{
"nhnm": "Rian Tarly",
"nhmob": "+61xxxxxxxxx",
"nheml": "Rian@example.com",
"chnl": "mob",
"nhstdt": "2018-01-12",
"managers": [
{
"nm": "John Doe",
"mob": "+61415xxxxxx",
"eml": "john@example.com",
"chnl": "mob",
"mgrlbl": "Direct Manager"
}
],
"customfields": [
{
"name": "Employee Number",
"value": "20268"
}
],
"externalid": "ENB-494398793433",
"mode": 0
},
{
"nhnm": "Jon Snow",
"nhmob": "+61666345673",
"nheml": "john@example.com",
"chnl": "eml",
"nhstdt": "2018-01-12",
"managers": [
{
"nm": "John Doe",
"mob": "+61415xxxxxx",
"eml": "john@example.com",
"chnl": "eml",
"mgrlbl": "Direct Manager"
}
],
"customfields": [
{
"name": "Employee Number",
"value": "20268"
}
],
"externalid": "ENB-494398793434",
"mode": 0
}
]
If one contact channel i.e. 'mob' or 'email' comes through blank it will just pick up the one that has come through - correct? It shouldn't error out.
Yes, if only one either mobile or email is available and another is blank (or not present), it will launch workflow and will NOT error out. In case both are present the system give preference to mobile.
Is chnl for manager and employee required or this is solely a preference?
Yes, it is not required. If provided, it will make the channel as preferred one. If not provided and both eml and mob present, we make mob as the default preferred channel.
If the chnl preference is 'mob' and the mob comes through blank, but the email field came through - will it go to email regardless?
No. In this case it will error out with message as "Employee preferred channel is mobile while mobile not provided."
Are custom fields required?
It depends on the workflow and custom field configuration. If any mandatory custom field is added to the workflow, then we need to provide that custom field at the time of launching workflow.
We can map Employee Number as the unique identifier with External ID?
Yes, just pass employee number in the external id field. I am sure employee number is unique in the source system.
Does auto bulk upload not allow for start date in the past?? Or is that just an error message thats acts as a warning but will still launch the WF?
The system will launched the workflow with warning message.
What security authentication is available?
All Requests can be submitted on Https only. All API Requests will require API Key to be passed in header as apikey. Optionally Rest API can be turned off/on at Account level by going to Company Account: ‘Settings’ / ‘Integration’ Page
Sample Header:
