Table of Contents
| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your own connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…).. |
The BambooHR modulesThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) allow you to monitor, create, update, retrieve, and delete the employees, employee files, time-offs, and time-off requests in your BambooHR account.
Prerequisites
- A BambooHR account
In order to use BambooHR with Boost.spaceCentralization and synchronization platform, where you can organize and manage your data. IntegratorPart of the Boost.space system, where you can create your connections and automate your processes., it is necessary to have a BambooHR account. If you do not have one, you can create a BambooHR account at bamboohr.com/signup/.
![[Note]](https://docs.boost.space/wp-content/uploads/2022/11/note.png) |
Note |
|---|---|
| The moduleThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) dialog fields that are displayed in bold (in the Boost.space Integrator scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive., not in this documentation article) are mandatory! |
To connect your BambooHR account to Boost.space Integrator you need to obtain the API Key from your BambooHR account and insert it in the Create a connection dialog in the Boost.space Integrator module.
- Log in to your BambooHR account.
- Click BambooHR icon (
) > API Keys > Add New Key. - Enter a name for the API and click Generate.
- Copy the API key to your clipboard and click Done.
- Go to Boost.space Integrator and open the BambooHR module’s Create a connection dialog.
- In the Connection name field, enter a name for the connection.
- In the Subdomain field, enter your account’s domain name. For example, if your account login URL address is
https://mycompany.bamboohr.comthen your domain is themycompany. - In the API Key field, enter the API Key copied in step 4, and click Continue.
The connection has been established.
Watches for added employees.
Connection |
Establish a connection to your BambooHR account. |
Limit |
Set the maximum number of employees Boost.space Integrator should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Returns a list of employees.
Connection |
Establish a connection to your BambooHR account. |
Limit |
Set the maximum number of employees Boost.space Integrator should return during one execution cycle. |
Returns employee data by specifying a set of fields.
Connection |
Establish a connection to your BambooHR account. |
Employee ID |
Select or map the Employee ID whose details you want to retrieve. |
Fields |
Select or map the fields you want to include in the employee details. |
Adds a new employee.
Connection |
Establish a connection to your BambooHR account. |
Synced with Trax Payroll |
Select whether you want to create a Trax payroll employee. |
First Name |
Enter (map) the employee’s first name. |
Last Name |
Enter (map) the employee’s last name. |
Employee Number |
Enter (map) the employee’s number. |
Date of Birth |
Enter the employee’s date of birth. |
SSN |
Enter the employee’s social security number. |
Gender |
Select or map the employee’s gender. For example, male. |
Marital StatusCreate statuses for each module separately to create an ideal environment for efficient and consistent work. |
Select or map the employee’s marital status. For example, Single. |
Hire Date |
Enter the date on which the employee was hired for the job. |
Address |
Enter the employee’s address. |
City |
Enter the city name. |
State |
Enter the state name. |
Country |
Enter the country name. |
Employment Status |
Select or map the employment status of the employee. |
Exempt |
Select whether the employee is exempted from taxes. |
Pay Type |
Select or map the employee pay type. For example, hourly, weekly. |
Pay Rate |
Select or map the employee pay rate in US Dollars. For example, if you have selected Pay Type as hourly then enter the employee’s hourly rate. |
Pay Per |
Select or map the frequency of payment to the employee. For example, Monthly. |
Location |
Select or map the employee location. |
Department |
Select or map the department to which the employee belongs to. For example, Human Resources. |
Division |
Enter (map) the division to which the employee belongs to. For example, Europe. |
Updates a specified employee.
Connection |
Establish a connection to your BambooHR account. |
Employee ID |
Select or map the Employee ID whose details you want to update. |
Synced with Trax Payroll |
Select whether you want to create a Trax payroll employee. |
First Name |
Enter (map) the employee’s first name. |
Last Name |
Enter (map) the employee’s last name. |
Employee Number |
Enter (map) the employee’s number. |
Date of Birth |
Enter the employee’s date of birth. |
SSN |
Enter the employee’s social security number. |
Gender |
Select or map the employee’s gender. For example, male. |
Marital Status |
Select or map the employee’s marital status. For example, Single. |
Hire Date |
Enter the date on which the employee was hired for the job. |
Address |
Enter the employee’s address. |
City |
Enter the city name. |
State |
Enter the state name. |
Country |
Enter the country name. |
Employment Status |
Select or map the employment status of the employee. |
Exempt |
Select whether the employee is exempted from taxes. |
Pay Type |
Select or map the employee pay type. For example, hourly, weekly. |
Pay Rate |
Select or map the employee pay rate in US Dollars. For example, if you have selected pay type as hourly then enter the employee’s hourly rate. |
Pay Per |
Select or map the period of payment to the employee. For example, Monthly. |
Location |
Select or map the employee location. |
Department |
Select or map the department to which the employee belongs to. For example, Human Resources. |
Division |
Enter (map) the division to which the employee belongs. For example, Europe. |
Returns a list of employee files.
Connection |
Establish a connection to your BambooHR account. |
Employee ID |
Select or map the Employee ID whose files you want to list. |
Limit |
Set the maximum number of files Boost.space Integrator should return during one execution cycle. |
Returns a specified employee file.
Connection |
Establish a connection to your BambooHR account. |
Employee ID |
Select or map the Employee ID whose files you want to download. |
File ID |
Select or map the File ID you want to download. |
Creates an employee file.
Connection |
Establish a connection to your BambooHR account. |
Employee ID |
Select or map the Employee ID whose files you want to list. |
File Name |
Enter the file name including the file extension. For example, test.txt |
File |
Enter or map the file data. |
Share with Employee |
Select the checkbox if you want to share the file with an employee. |
Updates a specified employee file.
Connection |
Establish a connection to your BambooHR account. |
Employee ID |
Select or map the Employee ID whose file you want to update. |
File ID |
Select or map the File ID whose details you want to update. |
Share with Employee |
Select the checkbox if you want to share the file with an employee. |
Category ID |
Select or map the Category ID to which the file belongs to. |
Name |
Enter a new name for the file. |
Deletes a specified employee file.
Connection |
Establish a connection to your BambooHR account. |
Employee ID |
Select or map the Employee ID whose file you want to delete. |
File ID |
Select or map the File ID whose details you want to delete. |
Watches for newly created time-offs for the specified time boundaries.
Connection |
Establish a connection to your BambooHR account. |
Start Time |
Enter (map) the start time to watch the time-offs that match the specified time. See the list of supported date and time formats. |
End Time |
Enter (map) the end time to watch the time-offs that match the specified time. See the list of supported date and time formats. |
Limit |
Set the maximum number of time-offs Boost.space Integrator should return during one execution cycle. |
Returns a list, sorted by date of employees who will be out and company holidays for a period of time.
Connection |
Establish a connection to your BambooHR account. |
Start Time |
Enter (map) the start time of the employee off or holiday whose details you want to retrieve. See the list of supported date and time formats. |
End Time |
Enter (map) the end time of the employee off or holiday whose details you want to retrieve. See the list of supported date and time formats. |
Limit |
Set the maximum number of employee time offs or holidays Boost.space Integrator should return during one execution cycle. |
Watches for newly created time off requests which can be approved by you.
Connection |
Establish a connection to your BambooHR account. |
Start Time |
Enter (map) the start time to watch the time-off requests that start on or after the specified time. See the list of supported date and time formats. |
End Time |
Enter (map) the end time to watch the time-off requests that end on or before the specified time. See the list of supported date and time formats. |
Limit |
Set the maximum number of time-off requests Boost.space Integrator should return during one execution cycle. |
Returns a list of time off requests with specified options.
Connection |
Establish a connection to your BambooHR account. |
Start Time |
Enter (map) the start time to search the time-off requests that start on or after the specified time. See the list of supported date and time formats. |
End Time |
Enter (map) the end time to search the time-off requests that end on or after the specified time. See the list of supported date and time formats. |
Time Off Request ID |
Select or map the Time-off Request ID whose details you want to search. |
Action |
Select or map the time-off requests access to search only the requests that match the specified action:
|
Employee ID |
Select or map the Employee ID to search the specified employee time-off requests. |
Type |
Select the time-off request type to search only the request that matches the specified type. For example, Bereavement. |
Status |
Select the status of the time-off request to search only the request that matches the specified status. For example, Approved. |
Limit |
Set the maximum number of time-off requests Boost.space Integrator should return during one execution cycle. |
Changes the status of a time-off request in the system. You can use this to approve or deny, or cancel a time-off request.
Connection |
Establish a connection to your BambooHR account. |
Request ID |
Select or map the Request ID whose status you want to change. |
Status |
Select or map the status to which you want to update the request:
|
Note |
Enter the details for updating the request status. |
Performs an arbitrary authorized API call.
Connection |
Establish a connection to your BambooHR account. | |||
URL |
Enter a path relative tohttps://api.bamboohr.com/api/gateway.php/<domain>. For example: /v1/meta/fields.
|
|||
Method |
Select the HTTP method you want to use:
to retrieve information for an entry.
to create a new entry.
to update/replace an existing entry.
to make a partial entry update.
to delete an entry. |
|||
Headers |
Enter the desired request headers. You don’t have to add authorization headers; we’ve already done that for you. | |||
Query String |
Enter the request query string. | |||
Body |
Enter the body content for your API call. |
The following API call returns all the company file categories from your BambooHR account:
URL:
/v1/files/view
Method:
GET
Matches of the search can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. > Body > Categories.
In our example, 3 categories were returned:
