Availability

Airbyte Cloud Airbyte OSS PyAirbyte

Support Level

Community

Latest Version

0.2.2

BambooHR

This page contains the setup guide and reference information for the BambooHR source connector.

Prerequisites

• BambooHR Account
• BambooHR API key

Setup Guide

Step 1: Set up the BambooHR connector in Airbyte

For Airbyte Cloud:

1. Log into your Airbyte Cloud account.
2. In the left navigation bar, click Sources. In the top-right corner, click + New source.
3. On the Set up the source page, enter the name for the BambooHR connector and select BambooHR from the Source type dropdown.
4. Enter your subdomain. If you access BambooHR at https://mycompany.bamboohr.com, then the subdomain is "mycompany".
5. Enter your api_key. To generate an API key, log in and click your name in the upper right-hand corner of any page to get to the user context menu. If you have sufficient administrator permissions, there will be an "API Keys" option in that menu to go to the page.
6. (Optional) Enter any Custom Report Fields as a comma-separated list of fields to include in your custom reports. Example: firstName,lastName. If none are listed, then the default fields will be returned.
7. Toggle Custom Reports Include Default Fields. If true, then the default fields will be returned. If false, then the values defined in Custom Report Fields will be returned.
8. Click Set up source

For Airbyte OSS:

1. Navigate to the Airbyte Open Source dashboard.
2. Set the name for your source.
3. Enter your subdomain. If you access BambooHR at https://mycompany.bamboohr.com, then the subdomain is "mycompany".
4. Enter your api_key. To generate an API key, log in and click your name in the upper right-hand corner of any page to get to the user context menu. If you have sufficient administrator permissions, there will be an "API Keys" option in that menu to go to the page.
5. (Optional) Enter any Custom Report Fields as a comma-separated list of fields to include in your custom reports. Example: firstName,lastName. If none are listed, then the default fields will be returned.
6. Toggle Custom Reports Include Default Fields. If true, then the default fields will be returned. If false, then the values defined in Custom Report Fields will be returned.
7. Click Set up source

Supported sync modes

The BambooHR source connector supports the following sync modes:

Feature	Supported?
Full Refresh Sync	Yes
Incremental - Append Sync	No
SSL connection	Yes
Namespaces	No

Supported Streams

• Custom Reports

Limitations & Troubleshooting

Expand to see details about BambooHR connector limitations and troubleshooting.

Connector limitations

Rate limiting

BambooHR has the rate limits, but the connector should not run into API limitations under normal usage.

Please create an issue if you see any rate limit issues that are not automatically retried successfully.

Troubleshooting

• Check out common troubleshooting issues for the BambooHR source connector on our Airbyte Forum.

Reference

Config fields reference

Field

Type

Property name

string

subdomain

string

api_key

string

custom_reports_fields

boolean

custom_reports_include_default_fields

Changelog

Version	Date	Pull Request	Subject
0.2.2	2022-09-16	17684	Fix custom field validation retrieve
0.2.1	2022-09-16	16826	Add custom fields validation during check
0.2.0	2022-03-24	11326	Add support for Custom Reports endpoint
0.1.0	2021-08-27	5054	Initial release with Employees API