Cleary imports data from BambooHR using Custom Reports.
Follow the steps below to generate the custom report that you want to share with Cleary and also the api_key for access:
- Note down the subdomain of your company’s BambooHR account. It’s the first part of the BambooHR URL. Ex. for the URL https://cleary.bamboohr.com/ Cleary is the subdomain
- Create a Custom Report in BambooHR, and follow the steps in the BambooHR documentation, the video on this page also gives a good overview of the process and is only 1.5 minutes long.
- Make sure to select at least the following fields:
- Employee #
- Supervisor ID
- Last Name
- First Name
- Preferred Name
- Hire Date
- Termination Date
- Work Email
- Job Title
- Employment Status
- City
- Supervisor (boolean field: true or false)
- Birth Date
- Country
- Employee photo url
- Other fields you might want to add:
- Region
- Department
- Team
- Sub-Team
- Make sure to select at least the following fields:
- Note down the custom report id, it’s a number like 123
- Note down the BambooHR’s api_key. It’s a string similar to ef15uu2u4f2f2e1a25f2e452u0274f20e8af262a
- “To generate an API key, users should log in and click their name in the upper right-hand corner of any page to get to the user context menu. If they have sufficient permissions, there will be an "API Keys" option in that menu to go to the page.” https://documentation.bamboohr.com/docs
- Open Cleary app integrations page /admin/app_integrations
- Scroll down to People
- Then you’ll see the BambooHR integration option, click the button and fill the form with the data from previous steps
How to sync teams and subteams
When syncing in team information, Cleary will create team structures based on the department, team, and sub-teams synced from BambooHR.
Example:
{
department: Engineering
team: Integrations
sub-team: Reliability
}
The team synced in the `department` field will be the parent of the teams synced in the `team` field. And the team synced in the `team` field will be the parent of teams synced in the ` `sub-team` field.
FAQs:
Q: We have a BambooHR <> Cleary sync issue. Our Org Chart isn't showing up correctly on the platform. Why is this happening?
A: This usually happens when the BambooHR Report sent to Cleary contains incorrect/missing user data. For instance, users may not be present in the report because they're under a particular group that's filtered out. To avoid this, make sure that there are no filters applied to the report and nothing is excluded. Also, see to it that the data being fed to Cleary is as updated as possible.