BambooHR: How to Create an API Key and Retrieve Subdomain

To utilize the new hire integration between BambooHR and ClearCompany, the initial step is to provide ClearCompany with your BambooHR subdomain, and create an API key within BambooHR.

Continue reading to learn how to provide both of these foundational data points.

Subdomain

This is simply the unique BambooHR identifier which can be found inside the URL at which you access their system.

If you access BambooHR at https://mycompany.bamboohr.com, then your subdomain is "mycompany"

Creating an API Key

The API key will be used by ClearCompany to securely transfer new hire data between our systems. Please note that, per BambooHR's API documentation:

The API secret key is a 160-bit number expressed in hexadecimal form. This is an astronomically large number of unique keys, which means that guessing an API key is nearly impossible.

1. First, login to your environment using a service account created specifically for ClearCompany. The user account permissions will determine what access ClearCompany will have visibility to. This means that if you create any custom fields, you will need to make these are visible to the ClearCompany account.
   Once logged in, click on the icon on the top right.
   

   

2. Select "API Keys"
   

   

3. Click "Add New Key"
   

   

4. In the new window, enter ClearCompany as your API Key Name and click "Generate Key"
   

   

5. Copy the API Key and provide this to the ClearCompany representative assisting you with your integration setup.
   

   

 Key Notes

• The process detailed above will be the only time you can view the key. If the key is lost, you will need to generate a new one.
• The API Key permissions are tied to the User account that was used. If you delete the user account or remove the permissions on this account, this will affect the integration's ability to pull data appropriately.