BambooHR
Add a bot to BambooHR using the official integration.
The official BambooHR integration allows your bot to interact with your company’s BambooHR employees.
Setup
You will need:
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.
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.
Cards
Get Company Info
Retrieve information about the company.
outputobjectGet Basic Info
Retrieve basic information about an employee by their ID.
inputobjectoutputobjectGet Custom Info
Retrieve custom information about an employee by their ID and specified fields.
inputobjectoutputobjectGet Employee Fields
Retrieve the list of available employee fields.
outputobjectList Employees
Retrieve a list of all employees with IDs and names. Warning: this endpoint may not be enabled in your workspace.
outputobjectTriggers
Employee Created
Triggers when a new employee is created in BambooHR.
payloadobjectEmployee Deleted
Triggers when an employee is deleted from BambooHR. Terminating employees will trigger the "Employee Updated" event instead.
payloadobjectEmployee Updated
Triggers when an existing employee is updated in BambooHR.
payloadobject