BambooHR Connector Configuration
The BambooHR connector enables App Xchange users to improve workflows by seamlessly integrating their HR data with other applications.
The BambooHR connector facilitates programmatic access to BambooHR data, enabling integration with external applications. It provides read and write capabilities across core HR data domains, including employee records, pay stubs, custom fields, direct deposit information, employee files, custom tables, time-off balances, time-off types, and time-off requests.
User Access
The links below provide details on accessing BambooHR as a user, developer, or partner.
Engagement and Training
This product does not yet provide engagement or training resources.
Technical Documentation
Technical documentation for this product may be viewed at BambooHR Documentation.
Connector Endpoints
The documentation below is an OpenAPI description (OAD) of each module in this connector.
Note: This is provided as a quick view of coverage and capabilities. The API and endpoints documented are used internally by the platform and not directly by end users.
Connection in App Xchange
Create an API Key
Before you can configure the BambooHR connector, you must create an API Key in BambooHR for your App Xchange integration. This is your authentication key.
In BambooHR, select API Keys from the menu dropdown.
Select +Add New Key.
Name your API Key. It is recommended you use App Xchange Integration in your key name. For example, App Xchange Integration for Viewpoint Vista.
Select Generate Key.
Your API key is created. You can now configure the connection details for this connector on App Xchange.
Connection Details
This connector has not yet been updated to use a formally defined connection. Details on configuring this connector and providing the credentials needed for integration usage are provided below.
Additional Configuration
Real-time Action Processing: This feature should always be enabled for optimal performance. Only disable it if you are advised to do so by support.
BambooHR API Details
BaseUrl: https://api.bamboohr.com/api/gateway.php (default)
SubDomain: Enter the subdomain name for the company you want to integrate.
AuthenticationKey: Enter the API key you created at the beginning.
Direct Deposit Configuration
TableName: This field is not currently used for standard integrations. Leave this blank unless you are advised to do otherwise.
EffectiveDatePropertyName: This field is not currently used for standard integrations. Leave this blank unless you are advised to do otherwise.
BankNamePropertyName: This field is not currently used for standard integrations. Leave this blank unless you are advised to do otherwise.
BankAccountTypePropertyName: This field is not currently used for standard integrations. Leave this blank unless you are advised to do otherwise.
AccountNumberPropertyName: This field is not currently used for standard integrations. Leave this blank unless you are advised to do otherwise.
RoutingNumberPropertyName: This field is not currently used for standard integrations. Leave this blank unless you are advised to do otherwise.
StatusPropertyName: This field is not currently used for standard integrations. Leave this blank unless you are advised to do otherwise.
PercentPropertyName: This field is not currently used for standard integrations. Leave this blank unless you are advised to do otherwise.
AmountPropertyName: This field is not currently used for standard integrations. Leave this blank unless you are advised to do otherwise.
Employee Custom fields: BambooHR usually writes all custom fields to the cache. However, if it does not, you can use this field to retrieve any custom field values that were not cached.
NOTE: If you enter at least one value here, you must enter all other custom field names here to force BambooHR to provide the values.
CustomTables: Enter the name of the custom direct deposit table you created as a part of your initial integration setup. The table should include the following columns: BankName, BankAccountType, AccountNumber, RoutingNumber, Status, Percent, Amount, EffectiveDate.
System Interface Config
Base Url of the Ryvit AppNetwork Environment: https://api.xchange.trimble.com/connect/v1 (default)
Partner Api Key: This field is pre-populated with a unique API key issued to you by App Xchange.
User Support
If you encounter a problem or need support for this connector, please create a ticket at App Xchange Support or email xchange_support@trimble.com.
Was this helpful? Give us feedback.