Configure BambooHR as a Source in your Pipeline

Perform the following steps to configure your BambooHR Source:

1. Click Pipelines in the Navigation Bar.

2. Click + Create Pipeline in the Pipelines List View.

3. On the Select Source Type page, select BambooHR.

4. On the Select Destination Type page, select the type of Destination you want to use.

5. In the Configure Source screen, specify the following:

   

   • Source Name: A unique name for your Source, not exceeding 255 characters. For example, BambooHR Source.

   • In the Connect to your BambooHR account section, specify the following:

     • API Key: The API key that you obtained from your BambooHR account.

     • Subdomain: The unique identifier for your BambooHR account. For example, in https://hevo.bamboohr.com, the subdomain is hevo.

6. Click Test & Continue to test the connection to your BambooHR Source. Once the test is successful, you can proceed to set up your Destination.

---

Data Replication

Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline.

Selecting a parent object automatically includes all its associated child objects for replication. Child objects cannot be selected or deselected individually.

Hevo ingests the following types of data from your Source objects:

• Historical Data: The first run of the Pipeline ingests all available historical data for the selected objects and loads it into the Destination.

• Incremental Data: Once the historical load is complete, new and updated records for objects are ingested as per the sync frequency.

For the Employee object, Hevo ingests only the incremental data in subsequent Pipeline runs. Incremental changes are detected using the lastChanged timestamp fields.

For all other objects, Hevo ingests the entire data during each Pipeline run.

Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.

Currently, BambooHR enforces a rate limit of 60 API requests per minute (approximately one request per second). If this limit is exceeded, a rate limit exception occurs. Hevo handles such scenarios using built-in retry logic, applicable to both historical and incremental ingestion:

• When a rate limit is encountered, Hevo waits 60 seconds before retrying the request.

• Each rate-limited request is retried up to three times. If all retries fail, the job is marked as Failed. Read Handling Rate Limit Exceptions for more information.

For the Employee object, Hevo uses BambooHR’s Custom Reports API for ingesting data with incremental sync support. This API supports a maximum of 400 fields per request. If your BambooHR account includes more than 400 standard or custom fields:

• Hevo automatically splits the request into multiple batches.

• The batched results are merged before loading into the Destination, ensuring all Employee fields are ingested without data loss.

---

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.

---

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

Note:

• The Employee object schema is dynamically generated based on the fields configured in your BambooHR account. The fields available for ingestion may vary depending on your BambooHR plan and any custom fields configured in your account. Schema changes are automatically detected and applied during subsequent Pipeline runs.

• The Employee Time Off Policy object is a junction table that connects employees with their assigned time off policies.

---