Bamboo HR
App Vendor: Bamboo HR
App Category: IT Services
Connector Version: 1.0.0
API Version: 1.0.0
About App
Bamboo HR allows analysts to connect to the HR management platform, and automate HR related tasks.
The Bamboo HR app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Get Employee Directory | This action retrieves the employee directory from Bamboo HR. |
Get Employee Details | This action retrieves the employee details from Bamboo HR. |
List Fields | This action retrieves a list of fields available from Bamboo HR. |
Update Employee Details | This action updates an employee, based on the employee ID. |
List Company Files and Categories | This action lists the company files and categories. |
Add Company File Category | This action adds a company file category. |
Gets a Company File | This action retrieves a company file. |
Deletes a Company File | This action deletes a company file. |
Get Company Report | This action requests one of your pre-existing company reports from the reporting section. |
Request a Custom Report | This action requests Bamboo HR to generate a report. |
Get All Updated Employee Table Data | This action retrieves the updated employee details from a specific date and time. |
Get Table Rows for a Given Employee and Table Combination | This action retrieves a data structure representing all the table rows for a given employee and table combination. |
Get List of Users | This action retrieves a list of users. |
Get all Updated Employee IDs | This action retrieves all the updated employee IDs. |
Upload a Company File | This action uploads a company file. |
Configuration Parameters
The following configuration parameters are required for the Bamboo HR app to communicate with the Bamboo HR enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain Name | Enter the base domain to connect. Example: If the URL is https://domainxyz.bamboohr.com, the base domain will be "domainxyz". | Text | Required | |
API Key | Enter the API key to authenticate the base domain. Example: "xxx-12@-xxK9" | Password | Required |
Action: Get Employee Directory
This action retrieves the employee directory from Bamboo HR.
Action Input Parameters
This action does not require any input parameter.
Action: Get Employee Details
This action retrieves the employee details from Bamboo HR.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Employee ID | Enter the employee ID. Example: "5" | Text | Required | |
Field list | Enter the comma separated list of values taken from the official list of field names. Example: $LIST[firstname,lastname] | List | Required |
Example Request
[
{
"field_list": [
"firstName",
"lastName",
"preferredName",
"payRateEffectiveDate"
],
"employee_id": "5"
}
]Action: List Fields
This action retrieves a list of fields available from Bamboo HR.
Action Input Parameters
This action does not require any input parameter.
Action: Update Employee Details
This action updates an employee, based on the employee ID.
If an employee is currently on a pay schedule syncing with TRAXPayroll or being added to one, the API user needs to update the employee with all of the required fields for the update to be successful.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Employee ID | Enter the employee ID. Example: "5" | Text | Required | |
First name | Enter the first name of the employee. Example: "John" | Text | Optional | |
Last name | Enter the last name of the employee. Example: "Doe" | Text | Optional | |
Job title | Enter the job title of the employee. Example: "Marketing Manager" | Text | Optional | |
Work phone no | Enter the work phone number. Example:"9876543210" | Text | Optional | |
Work email | Enter the work email. Example: "JohnDoe@xyz.com" | Text | Optional | |
Department | Enter the department. Example: "Marketing" | Text | Optional | |
Location | Enter the location. Example: "New York" | Text | Optional | |
Extra params | Enter the list of other possible fields which can be fetched from the action list fields. Example: "preferredName": "Ashleyy" | Key Value | Optional |
Example Request
[
{
"employee_id": "5",
"extra_params": {
"preferredName": "Ashleyy"
}
}
]Action: List Company Files and Categories
This action lists the company files and categories.
Action Input Parameters
This action does not require any input parameters.
Action: Add Company File Category
This action adds the company file category.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Payload | Enter the employee file category. Example: $LIST[category1, category2] | List | Required |
Example Request
[
{
"payload": [
"\"A NEW CATEGORY\""
]
}
]Action: Gets a Company File
This action retrieves a company file.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
File ID | Enter the ID of the company file being retrieved. Example: "220" | Text | Required |
Example Request
[
{
"file_id": "220"
}
]Action: Deletes a Company File
This action deletes a company file.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
File ID | Enter the ID of the company file to be deleted. Example: "175" | Text | Required |
Example Request
[
{
"file_id": "175"
}
]Action: Get Company Report
This action requests one of your pre-existing company reports from the reporting section.
Hover over the report name to get the report number on the reports page and obtain the ID. At present, only reports from the company reports section are supported.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Report ID | Enter the report ID. Example: "90" | Text | Required |
Example Request
[
{
"report_id": "90"
}
]Action: Request a Custom Report
This action requests Bamboo HR to generate a report.
Bamboo HR generates the report in the JSON form. You must list the fields to show on the report.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Report title | Enter the title of the report. Example: "Test Custom Report" | Text | Required | |
Fields | Enter the fields to request for. Example: $LIST[firstname,lastname] | List | Required | |
Date last changed | Enter the date in ISO 8601 format and the report will only include those employees whose records have changed since that time. Example: "2012-10-17T16:00:00Z" | Text | Required | |
Include null | Enter true to hide the null change dates, else enter false. Example: "True" | Boolean | Optional |
Example Request
[
{
"fields": [
"firstName",
"lastName"
],
"report_title": "Test Custom Report",
"date_last_changed": "2012-10-17T16:00:00Z"
}
]Action: Get All Updated Employee Table Data
This action retrieves the updated employee details from a specific date and time.
This action is an optimization to avoid downloading all table data for all employees.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Table name | Enter the table name. Example: 'jobInfo' | Text | Required | |
Since | Enter the timestamp in the ISO 8601 format. Example: "2012-01-29T11:53:05Z" | Text | Required |
Example Request
[
{
"since": "2012-01-29T11:53:05Z",
"table_name": "jobInfo"
}
]Action: Get Table Rows for a Given Employee and Table Combination
This action retrieves a data structure representing all the table rows for a given employee and table combination.
The result is not sorted in any particular order.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Table name | Enter the table name. Example: "jobInfo" | Text | Required | |
Employee ID | Enter the employee ID. Example: "5" | Text | Required |
Example Request
[
{
"table_name": "jobInfo",
"employee_id": "5"
}
]Action: Get List of Users
This action retrieves a list of users.
Action Input Parameters
This action does not require any input parameters.
Action: Get all Updated Employee IDs
This action retrieves all the updated employees IDs.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Since date | Enter the date and time in ISO 8601 format. Following are the ISO 8601 formats:
Example: "2011-06-02T19:26:23+00:00" | Text | Required | |
Update type | Enter the type of variable to be updated. Example: "Inserted" | Text | Optional | Allowed values:
|
Example Request
[
{
"since_date": "2011-06-02T19:26:23+00:00",
"update_type": "inserted"
}
]Action: Upload a Company File
This action uploads a company file.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
File path | Enter the local file path to fetch the file from. Example: "/tmp/306bc993-4359-4896-bddf-603d0056530c/THISISATESTFILE.txt" | Text | Required | |
Category ID | Enter the category ID to place the new file in. Example: "181" | Text | Required | |
File name | Enter the name of the file to be uploaded. Example: "Testfile.txt" | Text | Required | |
Share | Enter true to share the file with employees, else enter false. Example: "True" | Boolean | Optional |
Example Request
[
{
"file_name": "Testfile.txt",
"file_path": "/tmp/306bc993-4359-4896-bddf-603d0056530c/THISISATESTFILE.txt",
"category_id": "181"
}
]