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.
The links below provide details on accessing BambooHR as a user, developer, or partner.
This product does not yet provide engagement or training resources.
Technical documentation for this product may be viewed at BambooHR Documentation.
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.
Before you can use this connector, you must complete these steps.
Create an API key.
For instructions, see Create an API Key.
Enter the connector details in App Xchange.
Note: Depending on the workspace type, this connector uses either a connection or fields built into the general configuration to manage credentials. Either method works. Eventually, connections will be used in all workspaces to allow for more data protection enhancements.
Authentication Key: Enter the API key you created in step 1.
SubDomain: Enter the subdomain name for the company you want to integrate. For example, https://yourcompany.bamboohr.com.
The properties below influence the behavior of this connector. Which ones are necessary depends on the integrations or automations for which they are used.
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.
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.
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.