Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

The BambooHR connector lets you connect to a BambooHR instance and access BambooHR resources using the published APIs.

Configuring the connections

Following details are required to establish the connection

  1. 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 at https://mycompany.bamboohr.com, then the subdomain is "mycompany" and the API url will then be: https://api.bamboohr.com/api/gateway.php/mycompany/

  2. 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.

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.

  • No labels