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:
What can i expect from Integration Error Email?
Error emails include the key details inline, so you can resolve the issue without leaving your inbox:
Field | Description |
Employee | The employee name and ID associated with the failed record |
Account | The account the error occurred in |
Integration source | The system, resource path, and method involved (e.g. REST API) |
Occurred | Date, time, and timezone the error happened |
Status | The error status and HTTP code |
What happened | The specific response message describing the failure |
Workflow | The workflow name (blank/N/A for Profile API errors) and purpose (e.g. Launch, Update, Cancel, Create, Delete) |
Error reference code | A unique code to share with Customer Support if the issue persists |
A "View full log entry" link is still included if you need to see the complete details in the integration logs.
Note: This applies to error emails from both REST API and Profile API integrations.
Can i add multiple recipients for error notifications?
You can set more than one recipient to receive integration failure notifications. This includes:
Sending email if an integration fails
Sending email if a payload fails
How to add recipients
Go to Integrations settings.
Under Error Email Notifications, enter additional email addresses separated by commas in the recipient field.
Each address you add appears as a tag in the list below the field so you can review or remove them.
Limits
A maximum of 5 email addresses is allowed per notification type.
If you try to save more than 5, you'll see: "Maximum 5 emails allowed ā remove 1 to save." Remove an address to save your changes.
Questions? Contact our Support Team via Chat.