# BambooHR

## **Introduction**

This document provides detailed instructions for integrating BambooHR, a leading Human Resources (HR) management platform, with Automate, a robust workflow automation tool. BambooHR enables companies to streamline HR processes such as personnel management, recruitment, time tracking, performance evaluation, and training management. Integrating BambooHR with Automate enhances HR efficiency and simplifies administrative tasks for organizations of all sizes.

## **What is BambooHR?**

BambooHR is a comprehensive HR management software platform designed to assist companies in managing various aspects of their HR processes. It offers features for employee onboarding, offboarding, time off tracking, performance management, and more. BambooHR is widely used by businesses to improve HR operations and employee management.

## **Automate Integration with BambooHR**

Automate provides a set of pre-built actions to interact with BambooHR directly from your workflows. These actions empower users to automate essential HR tasks and access employee information seamlessly within BambooHR. But first you need to create your credentials into Autom Mate at [Vault ](/userguide/product-features/management/vault.md)page.

## **Credentials**

{% stepper %}
{% step %}
**Open Credential Settings**

Navigate to the Vault page in Autom Mate where you can securely store your application credentials.
{% endstep %}

{% step %}
**Add New Credential**

Click on **Add New Credential** to start setting up your BambooHR integration.
{% endstep %}

{% step %}
**Specify Connector Name**

Enter a friendly **Connector Name** for easy identification, which will be globally accessible within Autom Mate.
{% endstep %}

{% step %}
**Set Authentication Type**

Choose **basic** as the **Authentication Type** to authorize your BambooHR account.
{% endstep %}

{% step %}
**Enter Company Domain**

Provide your **Company Domain** for BambooHR.

* Example: For `autommate.bamboohr.com`, enter `autommate`.
  {% endstep %}

{% step %}
**Input API Key**

Enter your **BambooHR API Key** associated with your BambooHR account for secure access.
{% endstep %}

{% step %}
**Enter Password**

Specify your **BambooHR Account Password** to complete the authentication setup.
{% endstep %}

{% step %}
**Save Credentials**

Click **Save** to securely store your BambooHR credentials, enabling seamless integration with BambooHR services in Autom Mate.
{% endstep %}
{% endstepper %}

## How To Use Actions

### Add Employee

#### **Description and Purpose**

The **Add Employee** action enables users to create a new employee record within the BambooHR system. This functionality streamlines the onboarding process by directly adding essential employee information to BambooHR.

#### **Usage Instructions**

{% stepper %}
{% step %}
**Enter First Name**

Provide the first name of the new employee in the **First Name** field.
{% endstep %}

{% step %}
**Enter Last Name**

Specify the last name of the new employee in the **Last Name** field.
{% endstep %}

{% step %}
**Provide Email Address**

Enter the email address associated with the new employee in the **Email** field.
{% endstep %}

{% step %}
**Specify Hire Date**

Input the date when the employee was hired in the **Hire Date** field.
{% endstep %}
{% endstepper %}

{% hint style="success" %}

#### **Input** 

* **First Name**: The first name of the employee.
* **Last Name**: The last name of the employee.
* **Email**: The email address of the employee.
* **Hire Date**: The employee's official hire date.
  {% endhint %}

{% hint style="danger" %}

#### **Output** 

**BambooHR Response**: The response from BambooHR, confirming the successful addition of the employee record. This response may include details like employee ID or status.
{% endhint %}

***

### Get Employee with ID

#### **Description and Purpose**

The *Get Employee with ID* action retrieves details of a specific employee from BambooHR using their unique employee ID. This is helpful for obtaining targeted employee information within workflows where specific employee data is needed.

<figure><img src="/files/GAJvkjgn6N2cymuf1PT6" alt=""><figcaption></figcaption></figure>

#### **Usage Instructions**

{% stepper %}
{% step %}
**Enter Employee ID**

In the input field labeled *Employee ID*, provide the unique identifier of the employee whose information you want to retrieve.
{% endstep %}

{% step %}
**Execute the Action**

Run the action to fetch employee details from BambooHR. The system will return a response containing the specified employee's information.
{% endstep %}
{% endstepper %}

{% hint style="success" %}

#### **Input Fields**

**Employee ID**: The unique identifier of the employee in BambooHR whose details are to be retrieved.
{% endhint %}

{% hint style="danger" %}

#### **Output Fields**

**BambooHR Response**: Contains the response from BambooHR with the requested employee’s details, including all relevant information available in their record.
{% endhint %}

<details>

<summary>Sample Output</summary>

```json
{
  "address1": "8 Cotton Tree Drive",
  "address2": null,
  "bonusAmount": " USD",
  "bonusComment": null,
  "bonusDate": null,
  "city": "Provo",
  "commissionComment": null,
  "commissionDate": null,
  "country": "United States",
  "customSecondaryLanguage1": "German",
  "customShirtSize": "3. Large",
  "dateOfBirth": "1971-05-13",
  "department": "Operations",
  "division": "North America",
  "eeo": "Executive/Senior Level Officials and Managers",
  "employeeNumber": "13",
  "employmentHistoryStatus": "Full-Time",
  "ethnicity": "White",
  "exempt": "Exempt",
  "firstName": "Jake",
  "gender": "Male",
  "hireDate": "2021-09-28",
  "homeEmail": null,
  "homePhone": "801-724-6600",
  "id": "16",
  "jobTitle": "VP Learning and Development",
  "lastName": "Bryan",
  "location": "Lindon, Utah",
  "maritalStatus": "Married",
  "middleName": null,
  "mobilePhone": "801-724-6600",
  "nickname": null,
  "paidPer": "Year",
  "payChangeReason": "Promotion",
  "payRate": "90000.00 HKD",
  "payRateEffectiveDate": "2023-09-29",
  "paySchedule": "Twice a month",
  "payType": "Salary",
  "ssn": "555-75-7636",
  "state": "UT",
  "status": "Active",
  "terminationDate": "0000-00-00",
  "workEmail": "jbryan@efficientoffice.com",
  "workPhone": "801-724-6600",
  "workPhoneExtension": "1281",
  "zipcode": "84604"
}
```

</details>

***

### List Employees

#### **Description and Purpose**

The *List Employees* action retrieves a comprehensive list of all employees from BambooHR. This is useful for accessing full employee records for organizational overview, reporting, or further processing within workflows.

#### **Usage Instructions**

{% stepper %}
{% step %}
**Execute the Action**

Run the action without providing any additional input. The action will automatically connect to BambooHR and retrieve the complete list of employees.
{% endstep %}
{% endstepper %}

{% hint style="success" %}

#### **Input**&#x20;

**None required**: No specific input is needed to retrieve the employee list.
{% endhint %}

{% hint style="danger" %}

#### **Output**&#x20;

**BambooHR Response**: Contains the response from BambooHR, including a detailed list of all employees registered within the system.
{% endhint %}

{% hint style="info" %}

#### Hint

This action is optimal for workflows requiring bulk access to employee data from BambooHR without filtering for specific criteria.
{% endhint %}

***

### Update Employee

**Description and Purpose**

#### The *Update Employee* action allows users to modify existing employee details in BambooHR. This action is beneficial for keeping employee records current by updating information such as names, email addresses, and hire dates.

#### **Usage Instructions**

{% stepper %}
{% step %}
**Enter Employee ID**

Provide the unique identifier of the employee whose details need updating.
{% endstep %}

{% step %}
**Provide Updated Information**

* **First Name**: Enter the updated first name of the employee.
* **Last Name**: Specify the updated last name of the employee.
* **Email**: Provide the updated email address for the employee.
* **Hire Date**: Enter the revised hire date for the employee.
  {% endstep %}

{% step %}
**Execute the Action**

Run the action to apply the updates to the employee's profile in BambooHR.
{% endstep %}
{% endstepper %}

{% hint style="success" %}

#### **Input**&#x20;

* **Employee ID** (Required): The unique identifier for the employee to be updated.
* **First Name**: The updated first name of the employee.
* **Last Name**: The updated last name of the employee.
* **Email**: The updated email address of the employee.
* **Hire Date**: The updated hire date of the employee.
  {% endhint %}

{% hint style="danger" %}

#### **Output**&#x20;

**BambooHR Response**: Contains the response from BambooHR, confirming the successful update of the employee’s information.
{% endhint %}

***


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.autommate.com/userguide/libraries/integration/bamboohr.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.