BambooHR API

The BambooHR connector connects OnLink to a BambooHR instance so it can access BambooHR resources through the published APIs.

Step 1: Prepare connection details

Collect the following values before configuring the connector:

BambooHR API URL: BambooHR service endpoint URL. Set this to https://api.bamboohr.com/api/gateway.php/{company subdomain name}/, where {company subdomain name} is the subdomain in the URL used to access your BambooHR account in a browser.
- Example browser URL: https://mycompany.bamboohr.com
- Subdomain: mycompany
- Example API URL: https://api.bamboohr.com/api/gateway.php/mycompany/
BambooHR API Key: API key used to establish the connection. For BambooHR authentication details, see https://bamboohr.readme.io/docs#section-authentication.

Use the following procedure to create the BambooHR API key. BambooHR features may change, so consult BambooHR documentation if the screens differ.

You will need to have administrator privileges to perform the following actions.

1. Go to Profile > API keys.

2. Create a new API key by selecting Add New Key Name.

3. Provide a name for the new API key, such as OnLink, so you can identify where the key is used.

4. Copy the generated API key and save it securely. This is the API key you will use in the OnLink configuration.

Use the generated API key in the OnLink configuration.

Note that this API key is only visible here. You will no longer be able to retrieve this key after this step.

For more information, see the Bamboo HR documentation