All Collections
Enboarder API Docs
Workflow Data
Enboarder API Docs: Workflow Data
Enboarder API Docs: Workflow Data

This API contains different end points for launched workflow reports.

Kristen Rivera avatar
Written by Kristen Rivera
Updated over a week ago

Workflow List Endpoint

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

Report End Point: {{baseURL}}/reports/workflows

HTTP Method: GET

Description: To get list of workflow name and its ID

Response Notes:

A array of workflows with the following details

  • id - Workflow unique id

  • name - Workflow name

  • IsActive - Status of workflow

Sample Response:

{
"count": 3,
"items": [
{
"id": "O0lMYAwSv",
"name": "Rest API Testing",
"isActive": true
},
{
"id": "Vr4Q_-ttA",
"name": "Default Workflow",
"isActive": true
},
{
"id": "hx3cBcdvF",
"name": "Rest API Testing",
"isActive": false
}
]
}

Workflow Properties Endpoint

Base URLs:

AU ๐Ÿ‡ฆ๐Ÿ‡บ : https://api.syd.e1.enboarder.com

EU ๐Ÿ‡ช๐Ÿ‡บ : https://api.fra.e1.enboarder.com

US ๐Ÿ‡บ๐Ÿ‡ธ : https://api.ore.e1.enboarder.com

Report End Point: {{baseURL}}/reports/workflows/{id}/properties

HTTP Method: GET

Description: To get a list of categories, custom fields, & managers configured for this workflow

Param :

id - workflow unique id

Sample Response:

{
"name": "Sydney Series Test (10AM)",
"id": "Nym2o7QcZ",
"fields": [
{
"id": "HyXP8GBbOW",
"label": "Color Value",
"type": "customField",
"datatype": "picklist",
"options": [
{
"id": "Blue_SybPUMHbO-",
"value": "Blue"
},
{
"id": "Green_B1lDLfB-dZ",
"value": "Green"
},
{
"id": "Orange_HyGwLGSZd-",
"value": "Orange"
},
{
"id": "Red_B1vUzSWO-",
"value": "Red"
}
]
},
{
"id": "SyEfMSZd-",
"label": "Counter",
"type": "customField",
"datatype": "number"
},
{
"id": "rkmPfSWO-",
"label": "Description",
"type": "customField",
"datatype": "text"
},
{
"id": "rJv7MrZu-",
"label": "Reporting Date",
"type": "customField",
"datatype": "date"
},
{
"id": "SJWEMBW_b",
"label": "Reporting Time",
"type": "customField",
"datatype": "datetime"
},
{
"id": "NJ8MAOqUJZ",
"label": "Teacher",
"type": "manager",
"datatype": "variable"
},
{
"id": "V161uKSS-",
"label": "IT manager",
"type": "manager",
"datatype": "variable",
"isRequired": true
},
{
"id": "4yczutrSZ",
"label": "HR manager",
"type": "manager",
"datatype": "variable",
"isRequired": true
},
{
"id": "Vkc2ZTBUZ",
"label": "Payroll",
"type": "manager",
"datatype": "fixed",
"isRequired": true
}
]
}

Workflow Report Endpoint

Base URLs:

AU ๐Ÿ‡ฆ๐Ÿ‡บ : https://api.syd.e1.enboarder.com

EU ๐Ÿ‡ช๐Ÿ‡บ : https://api.fra.e1.enboarder.com

US ๐Ÿ‡บ๐Ÿ‡ธ : https://api.ore.e1.enboarder.com

End Point: {{baseURL}}/reports/workflows/data

HTTP Method: GET

Description: To get a list of workflows based on parameter configured. By default returns 1 year of data.

Attribute Name: launchStartDate

Type: String

Default Value: Current Date

Description: Format: yyyy-mm-dd (Ex: 2020-02-14) By default it will put current date.

Request Params (Optional):

Attribute Name: launchEndDate

Type: String

Default Value: Current Date - 12 months

Description: Format: yyyy-mm-dd (Ex: 2019-02-14) By default it will put 1 year before current date.

Attribute Name: nextKey

Type: String

Default Value: null

Description: The api will return 500 records in response. To get next set of record, please send this value in next request with same filters. Note - If no further records needs to fetch then its value will be blank in response

1 /reports/workflows/data?launchStartDate=2019-12-18&launchEndDate=2020-02-20&nextKey=2020020614163Kex42oMoh

Sample Response:

{
"count": 3,
"workflow": "TestBambooWebhook",
"id": "hx3cBcdvF",
"items": [
{
"id": "202003180404Agh5PhEAV",
"employee": "test launch",
"mobile": "+9198XXXXXXXX",
"email": "vneet+tanag@example.com",
"status": "in progress",
"startDate": "2020-03-18T12:00:00",
"launchDate": "2020-03-18T04:04:27",
"mode": "live",
"workflow": {
"id": "GLQeB7C27",
"name": "Asad - test Sutherland form signature stories"
},
"customFields": [
{
"id": "brand",
"label": "Brand",
"type": "category",
"datatype": "text",
"value": {
"id": "val_brand_imaPy3ot0",
"val": "David Jones"
}
},
{
"id": "location",
"label": "Location",
"type": "category",
"datatype": "text",
"value": {
"id": "val_location_4yMrck7S-",
"val": "Sydney"
}
},
{
"label": "Office Report Time",
"type": "category",
"datatype": "datetime",
"value": {
"id": "N18JrS6Y-",
"val": "09:30"
}
},
{
"label": "Reporting Date",
"type": "category",
"datatype": "date",
"value": {
"id": "rJv7MrZu-",
"val": "2020-03-18T12:00:00"
}
}
],
"managers": [
{
"id": "M_keuaCHIq",
"type": "manager",
"datatype": "Variable",
"value": {
"name": "Shuchi Manager",
"email": "example@example.com",
"phone": "+61XXXXXXXXX",
"preferedChannel": "eml"
}
}
]
}
],
"nextKey": "2020020614163Kex42oMoh"
}
....
],
"nextKey": "2020020614163Kex42oMoh"
}

Workflow Report with ID Endpoint

Base URLs

AU ๐Ÿ‡ฆ๐Ÿ‡บ : https://api.syd.e1.enboarder.com

EU ๐Ÿ‡ช๐Ÿ‡บ : https://api.fra.e1.enboarder.com

US ๐Ÿ‡บ๐Ÿ‡ธ : https://api.ore.e1.enboarder.com

End Point: {{baseURL}}/reports/workflows/{id}/data

HTTP Method: GET

Description: To get list of data for a particular workflow id. By default returns 1 year of data for selected workflow

Request Params (Optional):

Attribute Name: id

Type: String

Default Value: null

Description: Set it with workflow id for which you want to get data for a particular workflow.

Attribute Name: launchStartDate

Type: String

Default Value: Current Date

Description: Format: yyyy-mm-dd (Ex: 2020-02-14) By default it will put current date.

Attribute Name: launchEndDate

Type: String

Default Value: Current Date - 12 months

Description: Format: yyyy-mm-dd (Ex: 2019-02-14) By default it will put 1 year before current date.

Attribute Name: nextKey

Type: String

Default Value: null

Description: The API will return 500 records in response. To get the next set of records, please send this value in the next request with same filters. Note - If no further records needs to fetch then its value will be blank in response

1 /reports/workflows/hx3cBcdvF/data?launchStartDate=2019-12-18&launchEndDate=2020-02-20&nextKey=2020020614163Kex42oMoh


Sample Response:

{
"count": 3,
"workflow": "TestBambooWebhook",
"id": "hx3cBcdvF",
"items": [
{
"id": "202003180404Agh5PhEAV",
"employee": "test launch",
"mobile": "+9198XXXXXXXX",
"email": "vneet+tanag@example.com",
"status": "in progress",
"startDate": "2020-03-18T12:00:00",
"launchDate": "2020-03-18T04:04:27",
"mode": "live",
"workflow": {
"id": "GLQeB7C27",
"name": "Asad - test Sutherland form signature stories"
},
"customFields": [
{
"id": "brand",
"label": "Brand",
"type": "category",
"datatype": "text",
"value": {
"id": "val_brand_imaPy3ot0",
"val": "David Jones"
}
},
{
"id": "location",
"label": "Location",
"type": "category",
"datatype": "text",
"value": {
"id": "val_location_4yMrck7S-",
"val": "Sydney"
}
},
{
"label": "Office Report Time",
"type": "category",
"datatype": "datetime",
"value": {
"id": "N18JrS6Y-",
"val": "09:30"
}
},
{
"label": "Reporting Date",
"type": "category",
"datatype": "date",
"value": {
"id": "rJv7MrZu-",
"val": "2020-03-18T12:00:00"
}
}
],
"managers": [
{
"id": "M_keuaCHIq",
"type": "manager",
"datatype": "Variable",
"value": {
"name": "Shuchi Manager",
"email": "catchshuchi+it@gmail.com",
"phone": "+91XXXXXXXXXX",
"preferedChannel": "eml"
}
}
]
}
...........
],
"nextKey": "2020020614163Kex42oMoh"
}

Did this answer your question?