BambooHR is an HR management platform for employee data. The BambooHR connector allows you to ingest people information from your BambooHR instance into Glean using the BambooHR API. Data integration is authenticated through an API token, and all information is stored in any platform where the project is hosted, ensuring no data leaves your environment. Sensitive data such as salary information is not ingested by the connector.

Supported Features and Limitations

The BambooHR connector is designed to ingest essential employee directory fields from BambooHR, while explicitly excluding sensitive or unnecessary data.

Supported Fields

The connector ingests the following employee fields from BambooHR:
  • Employee name (including preferred and display names)
  • Email address
  • Status (active or inactive)
  • Job title
  • Department
  • Photo
  • Location
  • Hire date
  • Phone number
  • Supervisor/manager email

Supported API Endpoints/Features

  • /employees/directory: Used to collect all user IDs.
  • /employees/{id}: Used to fetch full details for each employee.
  • Only the fields listed above are are used to populate profile information in Glean.

Crawling Strategy

Crawl typeFull CrawlIncremental CrawlPeople DataActivityUpdate RateWebhookNotes
Employee DataYesNoYesNoOn demandNoUses /employees/directory and /employees/{id} endpoints
The connector performs a full crawl of the employee directory using the BambooHR API. Incremental crawls and webhooks are not supported.

Requirements

To use the BambooHR connector, you must meet the following requirements.
  • Access to the Glean admin console.
  • A BambooHR instance with the Company Directory feature enabled. This feature can be managed or disabled in BambooHR account settings. It must be turned on for Glean to crawl /employees/directory.
  • An API token generated in BambooHR is required for authentication. The API token must be created by a service account admin with access to the employee directory and basic employee fields.
  • The API token inherits all permissions from the user who creates it.

Configuration and Setup Instructions

Follow these steps to configure and set up the BambooHR connector in Glean. Most setup occurs in the Glean admin console and your BambooHR instance.

Generating the API token

Follow these steps to generate the API token:
  1. Log into BambooHR, and click your name in the upper right-hand corner to open the user context menu.
  2. Select API Keys and create a new API key.
  3. Copy the API key.

Connecting BambooHR connector to Glean

  1. In the Glean Admin console, navigate to the Advanced data source setup.
  2. Toggle to Config and add bamboohr.domain as the Key name.
  3. Add the domain of your BambooHR project into the Key value field and click Submit.
  4. Toggle to Secret.
  5. Add the BAMBOOHR_ACCESS_TOKEN as the Key name.
  6. Add the BambooHR API key into the Key value field and click Submit. 7.Save all configurations.
For any issues or questions, contact the Glean support team.

Permissions & Security

Data and Metadata Ingested:
  • Employee directory fields as listed above (name, email, status, job title, department, etc.)
  • No sensitive data (e.g., salary) is ingested
Permission Propagation Logic:
  • The connector enforces the permissions of the API token’s creating user. Only data accessible to that user is ingested.
Security & Compliance Notes:
  • Authentication is through the API token and no OAuth or explicit scopes are supported.
  • The service account used for the API token can be restricted to only the necessary fields.