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
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.
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.
An API key will be generated. This is the API Key you will use 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
Post Function Mapping
Add Employee Field Mapping
Add a new employee. New employees must have at least a first name and a last name. Other fields can be included.
First Name | The employee's first name. |
Last Name | The employee's last name. |
Hire Date (optional) | The date the employee was hired. |
All other fields are optional |
Output is Employee Id and will be set if the Add Employee call is successful
Update Employee Field Mapping
Employee ID | Update an employee, based on employee ID. Employee ID can be retrieved from the BambooHR system, the ID is part of the URL when accessing an employee’s profile |
All other fields are optional |
Output is Status and will be set to “success” if the Update Employee call is successful. If not successful, the field will be populated with the error message.
Terminate Employee Field Mapping
Employee ID | Employee ID can be retrieved from the BambooHR system, the ID is part of the URL when accessing an employee’s profile |
Termination Date | Date of termination. If this is in future, then the employee status will appear as “Active” until the termination date is reached. |
Employment Status | Set to “Terminated”; check your BambooHR system if the default value for the termination status has been changed. |
Output is Status and will be set to “success” if the Terminate Employee call is successful. If not successful, the field will be populated with the error message.
Webhooks
Follow instructions in our Webhook documentation to get started with creating a Webhook for BambooHR. Here are the config elements you will need to set:
config:auth_scheme=request_signing_bamboohrconfig:signature_token=<copy Private Signature Key from BambooHR https://documentation.bamboohr.com/docs/webhooks>
To map fields, use format like below. You can include all fields that are listed here - https://documentation.bamboohr.com/docs/webhooks
key:id=customfield_10121map:fields.First Name=customfield_10122map:fields.Last Name=customfield_10123
