BambooHR Connector Configuration
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.
Log in to BambooHR and select your user profile icon in the top right of the page.
Select API Keys.
Select +Add New Key.
Name your API Key.
It’s recommended you use App Xchange Integration in your key name. For example, App Xchange Integration for Viewpoint Vista.
Select Generate Key.
Manage Configuration
When setting up the BambooHR connector, review the following fields and enter values where necessary.
Connector 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.
Company Filter
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 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
Partner Api Key
This field is pre-populated with a unique API key issued to you by App Xchange.
Connector Endpoints
To see the API calls and endpoints in the BambooHR connector, view the OpenAPI documentation by module, found here: