Launch a Basic 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/basic
Using OAuth - {{baseURL}}/restapi/v2/startwf/basic

Request Method: POST

Sample Request:

{
  "nhnm": "Jane Doe",
  "nhfnm": "Jane", 
  "nhlnm": "Doe",
  "nhmob": “+61415xxxxxx",
  "nheml": “john@example.com”,
  "chnl": “mob”,
  "mgrnm": "John Doe”,
  "mgrmob": “+61415xxxxxx",
  "mgreml": “john@example.com",
  "mgrchnl": “mob”,
  "nhstdt": "2018-01-12",
  "customfields": [
    {
      "name": "brand",
      "value": “enboarder"
    },
    {
      "name": "location",
      "value": “Sydney"
    },
    {
      "name": “Employee Number",
      "value": “98786”
    }
  ],
  "externalid": “687368798490”,
  “mode”: 0
}

Response

On Success, the below response will be returned:

Response Body:

{ "message": "ok", "referenceid": "687368798490" }

Where the referenceid is the externalid passed in the 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 be contain the 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*

mgrnm

Full name of Manager

Required

mgrmob

Manager Mobile

Required*

mgreml

Manager email

Required*

mgrchnl

Preferred channel for manager

Required*

nhstdt

Start Date of Employee

Required

customfields

List of all custom fields for the workflow. They are name:value pairs. The name should match the label of custom field created in Enboarder. Brand, location and optional Categories can also be provided in custom fields with name as ‘brand’, ‘location’ and category name matching the label 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.