Setup
You will need:
1
Install the integration in Botpress
First, install the integration to your bot:
- In Botpress Studio, select Explore Hub in the upper-right corner.
- Search for the BambooHR integration, then select Install Integration.
- In the drop-down menu, select Configure manually with your BambooHR API Key.
- Fill the BambooHR Subdomain field with your company’s subdomain (
https://mycompany.bamboohr.com) - 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:
- Log in to BambooHR.
- Select your avatar in the bottom-left corner, then select API Keys.
- Select + Add New Key.
- Enter a name for the API key, then select Generate Key.
- 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:
- In the integration’s API Key field, paste your BambooHR API key.
- Select Save configuration.
Cards
Here’s a reference for all Cards available with the integration:Get Company Info
object
This Card has no input fields.
object
Get Basic Info
object
Get Custom Info
Get Employee Fields
object
This Card has no input fields.
List Employees
object
This Card has no input fields.
Triggers
Here’s a reference for all Triggers available with the integration:Employee Created
Employee Deleted
Employee Updated
object