Advanced Workflow

Base URL:

AU 🇦🇺 : https://api.syd.e1.enboarder.com

EU 🇪🇺 : https://api.fra.e1.enboarder.com

US 🇺🇸 : https://api.ore.e1.enboarder.com

CA 🇨🇦 : https://api.can.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",
  "nhexternalid": "nhext-001",
  "nheml": "john@example.com",
  "chnl": "mob",
  "nhstdt": "2016-08-12",
  "managers": [
    {
      "nm": "John Van Doe",
      "fnm": "Jane Van", 
      "lnm": "Doe", 
      "mob": "+61415xxxxxx",
      "eml": "john@example.com",
      "chnl": "mob",
      "mgrlbl": "Direct Manager"
    },
    {
      "externalid": "ext-0001",
      "mgrlbl": "Direct Manager"
    }
  ],
  "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:

Attribute Name	Description	Required (yes/no)
nhnm	Full name of Employee. It is optional in case nhexternalid is provided in payload	yes
nhfnm	First name of Employee. It is optional.	no
nhlnm	Last name of Employee. It is optional.	no
nhmob	Employee Mobile.	Either nhmob or nheml. It is optional in case nhexternalid is provided in payload
nheml	Employee Email	Either nhmob or nheml. It is optional in case nhexternalid is provided in payload
nhexternalid	Externalid of existing profile. In case this is passed in payload, then system will link existing profile for the candidate. The source system don’t need to pass nhnm, nhfnm,nhlnm, nhmob, nheml fields in this case.
chnl	Preferred channel for employee	no
nhmobeml	This is optional field. Use it in case you want to send either email or mobile in same field for candidate Note - The system will considered value of this field only if nhmob, nheml and chnl are not present in payload	no (optional)
managers	Ordered list of all variable managers required to start the workflow. Fields needed for each manager and shown below example manager.name	yes
manager.nm	name of the manager	yes
manager.fnm	first name of the manager.It is optional.
manager.lnm	last name of the manager.It is optional.
manager.externalid	Externalid of existing profile. In case this is passed in payload, then system will link existing profile for that manager. The source system don’t need to pass nm,fnm,lnm, mob, eml fields in this case	no (optional)
manager.mob	Manager email or Mobile	yes
manager.eml	Manager email or Mobile	yes
manager.chnl	Preferred channel for manager	no
manager.mobeml	This is optional field. Use it in case you want to send either email or mobile in same field for manager Note - The system will considered value of this field only if manager.mob, manager.eml and manager.chnl are not present in payload.	no
manager.mgrlbl	Label of manager, whose details need to be added. This is required in case of workflow has multiple variable managers	no
nhstdt	Start Date of Employee	yes
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.	no
externalid	This is a unique ID of the workflow. 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.	no
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.	no

*At least one contact channel is required. If both email and mobile are included, use channel to indicate sending preference.