Bamboo HR
Overview
The BambooHR connector enables you to configure BambooHR Human Resources Management System (HRMS) related integrations, such as generating/fetching reports, retrieving user data, and updating user information. This guide walks you through setting up and configuring the connector.
Setup
Prerequisites
Before setting up the BambooHR connector, ensure you have:
- Administrator privileges in your BambooHR account.
- Access to generate API keys or API tokens in BambooHR.
- Your company's BambooHR domain (e.g.,
yourcompany.bamboohr.com). - Access to your Leena AI workspace with connector management permissions.
Get Credentials
The BambooHR connector uses Basic Authentication.
Obtain BambooHR API Credentials
- Log in to your BambooHR account with administrator privileges.
- Navigate to the account settings or API section.
- Generate an API key or use your username and API token for authentication.
Add Connection
Step 1: Access the Integrations Page
- Log in to your Leena AI workspace.
- Navigate to Settings > Integrations.
- Click on Add Connector.
- Search for "BambooHR" and select it from the list.
Step 2: Configure Authentication
The BambooHR connector requires the following credentials:
- Company Domain: Your BambooHR company domain (e.g.,
yourcompany.bamboohr.com). - API Key or Username: Your BambooHR username or API key.
- API Token: Your BambooHR API token.
Step 3: Test and Save Configuration
- After entering all required fields, click Test Connection.
- If successful, click Save. The BambooHR connector is now ready to use in your workflows.
- If the test fails, verify your credentials and domain are correct.
Actions
The BambooHR connector supports the following actions for managing employee data and tables.
Update Employee
This action updates an employee's information in BambooHR. The Agent can leverage this to update user details.
Input Parameters
| Parameter | Requirement | Description |
|---|---|---|
| id | Mandatory | BambooHR employee ID. |
| firstName | Optional | Employee's first name. |
| lastName | Optional | Employee's last name. |
| Optional | Employee's email address. | |
| department | Optional | Employee's department. |
| position | Optional | Employee's job position. |
| workPhone | Optional | Employee's work phone number. |
| mobilePhone | Optional | Employee's mobile phone number. |
| hireDate | Optional | Employee's hire date. |
| Other fields | Optional | Many other dynamic fields (e.g., Address Line 1, Allergies, Benefit History) are available for update. |
Add Table Row (Generic)
This action adds a new row to a specified table for an employee in BambooHR.
Input Parameters
| Parameter | Requirement | Description |
|---|---|---|
| id | Mandatory | BambooHR employee ID. |
| table | Mandatory | Table name to which the row should be added. |
| [Table specific fields] | Optional | Dynamic fields based on the selected table. |
Note: Available tables depend on your BambooHR account configuration. Examples include:
jobinfo,emergencyContacts, anddependents.
Update a Table Row (Generic)
This action updates an existing row in a specified table for an employee in BambooHR.
Input Parameters
| Parameter | Requirement | Description |
|---|---|---|
| id | Mandatory | BambooHR employee ID. |
| table | Mandatory | Table name containing the row to update. |
| rowId | Mandatory | The ID of the row to update. |
| [Table specific fields] | Optional | Dynamic fields based on the selected table. |
Note: The row ID can be selected from a dropdown that appears after selecting the employee ID and table.
Delete a Table Row (Generic)
This action deletes a table row for a specified employee.
Input Parameters
| Parameter | Requirement | Description |
|---|---|---|
| id | Mandatory | BambooHR employee ID. |
| table | Mandatory | Table name containing the row to delete. |
| Row ID | Mandatory | The unique ID of the row to delete. |
| [Table specific fields] | Optional | Dynamic fields based on the selected table. |
Note: The available tables depend on your BambooHR account configuration. Examples include:
jobinfo,emergencyContacts, anddependents.
Updated about 20 hours ago
