| Table of Contents | ||
|---|---|---|
|
The BambooHR connector lets you connect to a BambooHR instance and access BambooHR resources using the published APIs.
...
Connection Setup
Following details are required to establish the connection
BambooHR API URL: BambooHR service endpoint URL. This should be set to
https://api.bamboohr.com/api/gateway.php/{company subdomain name}/where{company subdomain name}is in the URL used to access your account via browser. For example, if you access BambooHR athttps://mycompany.bamboohr.com, then the subdomain is "mycompany" and the API url will then be:https://api.bamboohr.com/api/gateway.php/mycompany/BambooHR API Key: API Key that will be used to establish the connection. Here's a link from BambooHR that provides more info: https://bamboohr.readme.io/docs#section-authentication .
How to generate an API Key in BambooHR
Please refer to documentation for more information.
Add BambooHR API key to OnLink
Paste the Bamboo HR API key into the API Key field.
Add your Bamboo HR subdomain to OnLink
Now you need to add your BambooHR subdomain.
API URL is https://api.bamboohr.com/api/gateway.php/{mycompany subdomain name}/
where {mycompany subdomain name} is in the URL used to access your account via browser. For example, if you access BambooHR at https://mycompany.bamboohr.com, then the subdomain is "mycompany" and the API url should be set to:
https://api.bamboohr.com/api/gateway.php/mycompany/Here are the steps to generate an API key in BambooHR. Please note the features may change and we recommend consulting with BambooHR for any changes.
| Info |
|---|
You will need to have administrator privileges to perform the following actions. |
Go to Profile > API keys
...
Create a new API key by selecting Add New Key Name
...
Provide a name for this new API key. For example, OnLink. This will help to identify where the API key is used.
...
| Tip |
|---|
An API key will be generated. This is the API Key you will use in the OnLink configuration. |
| Note |
|---|
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