Skip to main content
Open in Hubv1.0.0 The official BambooHR integration allows your bot to interact with your company’s BambooHR employees.

​
Setup

You will need:
1

Install the integration in Botpress

First, install the integration to your bot:
  1. In Botpress Studio, select Explore Hub in the upper-right corner.
  2. Search for the BambooHR integration, then select Install Integration.
  3. In the drop-down menu, select Configure manually with your BambooHR API Key.
  4. Fill the BambooHR Subdomain field with your company’s subdomain (https://mycompany.bamboohr.com)
  5. Leave the API Key field blank for now—you’ll come back to it after getting your BambooHR API key.
2

Get your BambooHR API key

Next, get your BambooHR API key:
  1. Log in to BambooHR.
  2. Select your avatar in the bottom-left corner, then select API Keys.
  3. Select + Add New Key.
  4. Enter a name for the API key, then select Generate Key.
  5. Copy the generated key.
If you get an error when trying to access the API keys menu (or can’t see the option to add a new key), make sure you have sufficient permissions in your company’s BambooHR account.
3

Configure the integration in Botpress

Now, you can finish setting up the integration in Botpress:
  1. In the integration’s API Key field, paste your BambooHR API key.
  2. Select Save configuration.
Your BambooHR integration is ready. You can use the integration’s Cards and Triggers to interact with your company’s employees.

​
Cards

Here’s a reference for all Cards available with the integration:

​
Get Company Info

Input: This Card has no input fields. Output:

​
Get Basic Info

Input: Output:

​
Get Custom Info

Input: Output:

​
List Employees

Input: This Card has no input fields. Output:

​
Triggers

Here’s a reference for all Triggers available with the integration:
You can access data returned from any of these Triggers by reading event.payload after the Trigger fires.

​
Employee Created

​
Employee Deleted

​
Employee Updated

​
payload
object