Advanced Workflow
Base URLs:
AU 🇦🇺 : https://api.syd.e1.enboarder.com
EU 🇪🇺 : https://api.fra.e1.enboarder.com
US 🇺🇸 : https://api.ore.e1.enboarder.com
API Endpoint
Using API Key - {{baseURL}}/restapi/v1/startwf/advance
Using OAuth - {{baseURL}}/restapi/v2/startwf/advance
Request Method: POST
Sample Request
{
"nhnm": "Jane Doe",
"nhfnm": "Jane",
"nhlnm": "Doe",
“nhmob": “+61415xxxxxx",
"nheml": “jane@enboarder.com”,
"chnl": “mob”,
"nhstdt": "2016-08-12",
"managers": [
{
"nm": "Jane Van Doe",
"fnm": "Jane Van",
"lnm": "Doe",
“mob": “+69493xxxxxx",
"eml": “john@enboarder.com”,
"chnl": “mob”,
“mgrlbl”: “Direct Manager”
},
{
"nm": "Susan Smith",
“mob": “+58493xxxxxx",
"eml": “susan@enboarder.com”,
"chnl": “mob”,
“mgrlbl”: “Recruiter”
}
],
"customfields": [
{
"name": "brand",
"value": “enboarder"
},
{
"name": "location",
"value": “Sydney"
},
{
"name": “Employee Number",
"value": “98786”
}
],
"externalid": “687368798490”,
“mode”: 0
}
Response:
On Success, below response will be return
Response Body:
{ "message": "ok", "referenceid": "687368798490" }
Where referenceid is externalid passed in request body or uniqueid generated by system launched from
On Error
Resposne Body:
{ "message": "Atleast one of the fields is required [\"nheml\",\"nhmob\",\"nhmobeml\"]" }
Message will contain error message
Attribute Names & Descriptions:
nhnm
Full name of Employee
Required
nhfnm
First name of Employee
Optional
nhlnm
Last name of Employee
Optional
nhmob
Employee Mobile
Required*
nheml
Employee Email
Required*
chnl
Preferred channel for employee
Required*
managers
Ordered list of all variable managers required to start the workflow. Fields needed for each manager and shown below example manager.name
Required
manager.nm
Full name of the manager
Required
manager.fnm
First name of the manager
Optional
manager.lnm
Last name of the manager
Optional
manager.mob
Manager email or Mobile
Required*
manager.eml
Manager email or Mobile
Required*
manager.chnl
Email of Manager, use it when you want to pass both email and mobile of Manager. manager.mobeml will have value of mobile in this case
Required*
manager.mgrlbl
Label of manager, whose details need to be updated.
Required*
nhstdt
Start Date of Employee
Required
customfields
List of all custom fields for the workflow. They are name , value pairs. name should match the name of custom field defined in Enboarder. Brand, location and optional categories can also be provided in custom fields with name as ‘brand’, ‘location’ and category name in Enboarder respectively.
Optional
externalid
Reference of external System to match with Enboarder Workflow. This should be unique for all workflows started in Enboarder. If external is not specified then Enboarder generates a unique ID for workflow, which can be used to perform update operations on Enboarder workflow programatically.
Optional
mode
Mode to launch workflow, possible values are:
0 (Default): Do not launch if any workflow exists with external ID.
1 : Cancel the existing workflow and launch new workflow with this external ID.
2 : Allow launching multiple workflows with same external id but different criteria. If workflow exists with same criteria, cancel the existing one and launch the new one.
Optional
*At least one contact channel is required. If both email and mobile are included, use channel to indicate sending preference.