Configure Connection
BambooHR guide
Generate an API key, configure the BambooHR connection in NIM, and validate employee data for downstream user provisioning.
Before you beginDirect link to Before you begin
Follow BambooHR's Getting Started API documentation, using its API key instructions for a single-customer integration. API access follows the permissions of the user who owns the key, including which employees and fields can be read.
NIM requires Subdomain, Username, and Password. For API key authentication, enter the API key as Username and an arbitrary non-empty string, such as x, as Password.
Obtain API credentialsDirect link to Obtain API credentials
- Sign in to the BambooHR account approved for the integration.
- Open the user context menu by selecting your name in the lower-left corner, then select API Keys. This option requires the appropriate permissions.
- Generate an API key and store it securely for NIM.
- Confirm that the account can access the employee data required by your downstream process.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a BambooHR system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Subdomain | The company name before .bamboohr.com. For https://mycompany.bamboohr.com, enter mycompany. |
| Username | The BambooHR API key. |
| Password | An arbitrary non-empty string such as x, as specified for BambooHR API key authentication. |
Test employee-directory accessDirect link to Test employee-directory access
-
Select Test Connection. NIM attempts to retrieve employees using:
GET /v1/employees/directory -
If the test fails, verify the Subdomain, API key in Username, Password value, network access, and the API key owner's permissions.
-
Collect the employee data required by your process and confirm that the expected records and fields are present.
-
Validate employee matching and field mappings before using the data for downstream user provisioning.
The connection test checks employee-directory retrieval. Validate other collections and field access required by your process separately.