BambooHR Integration

Generating a BambooHR API Key

1. Login to your BambooHR account and click your profile picture in upper right-hand corner of the page to get to the user context menu.

   If you have sufficient permissions, there will be an API Keys option in that menu.

   
   

   ℹ️

   How to Modify User Permission Levels:

   Using the Access Levels option under Settings, you can set permission levels for your users to full access, no access, or some preset permission levels: employee, manager, or custom. Remember that the API key inherits the permission set of the user. If a user doesn’t have access to X field, then the API key they generate won’t have access to that field either.

   
   

2. Navigate to the API Keys page then click Add New Key to create a new API key.

   

3. Name your API Key and click Generate Key

   

4. Copy the API Key from the popup and store it in a secure location for the next step.

   
   
   

❗️

Warning

This is the only time the API Key will be visible. If you lose this you will need to generate a new one.

Add Configuration

1. Navigate to the Integrations tab using the left-hand menu, and select BambooHR

   
   
   

2. Click the Add Configuration button and fill in the details below:

   
   
   
   

Name: Enter the name of the integration

is Enabled: Toggle button to ensure data is populated into Compyl

Base URL: The subdomain used to access your account (e.g. Given https://my_company.bamboohr.com, your subdomain would be my_company)

Key: The API Token you generated above

Once you have completed filling out the form click Save Configuration.

📘

Note

To check if the integration is connected, navigate to the Integrations page in Compyl. If the Status icon shows an unbroken link in the right-hand corner, your integration is properly connected.

This integration syncs daily.

To query the data from the integration, refer to the Query Builder article.