How to use IBM App Connect with BambooHR
BambooHR is a Human Resources Information System (HRIS) that combines a range of HR features such as time tracking, payroll processing, employee engagement, employee satisfaction tools, and Applicant Tracking System (ATS) into a single system.
- App Connect Enterprise as a Service connector
-
Local
connector in containers (Continuous Delivery release) 12.0.9.0-r2 or later -
Local connector in containers (Long Term Support Cycle-2 release)
Connecting to BambooHR
Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your BambooHR administrator to obtain these values.
| Connection field | Description |
|---|---|
| Subdomain | The subdomain used to access your BambooHR account. For example, mycompany.bamboohr.com. |
| API key | The integration key to identify your application to BambooHR for communicating with BambooHR APIs |
- Log in to your BambooHR account.
- On the BambooHR home page, click your profile icon, and then select API Keys.
- Click Add New Key.
- Enter an API Key Name and then click Generate Key.
- Click COPY KEY to copy your API key value and save it somewhere safe.
To connect to a BambooHR endpoint from the App Connect Designer Catalog page for the first time, expand BambooHR, then click Connect. For more information, see Managing accounts.
Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Catalog page, select the account, open its options menu (⋮), then click Rename Account.
General considerations
Before you use App Connect Designer with BambooHR, take note of the following considerations:
- (General consideration) You can see lists of the trigger events and
actions that are available on the Catalog page of the App Connect Designer.
For some applications, the events and actions in the catalog depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
- (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.
Events and actions
BambooHR events
These events are for changes in this application that trigger a flow to start completing the actions in the flow.
BambooHR actions
Your flow completes these actions on this application.
| Object | Action | Description |
|---|---|---|
| Employees | Create employee | Adds a new employee |
| Retrieve employees | Retrieve employee data by specifying a set of fields | |
| Update employee | Update an employee based on employee ID | |
| Update or create employee | Updates employee information if employee ID exits, else creates an employee object based on the information that is specified in the request body | |
| Employee dependents | Create employee dependent | Adds an employee dependent |
| Retrieve employee dependents | Retrieves all employee dependents | |
| Update employee dependent | Allows you to change the information for a given dependent ID | |
| Update or create employee dependent | Updates new dependent information if dependent ID exits, else creates a dependent object based on the information that is specified in the request body | |
| Benefit deduction types | Retrieve benefit deduction types | Retrieves benefit deduction types |
| Employee files | Retrieve employee file by ID | Retrieves an employee file by using employee ID |
| Download employee file content | Downloads the contents of employee file | |
| Update employee file | Updates an employee file | |
| Delete employee file | Deletes an employee file | |
| Custom reports | Request a custom report | Requests BambooHR to generate a custom report |
| Time tracking records | Create time tracking record | Adds a time tracking record |
| Retrieve time tracking record by ID | Retrieves a time tracking record by using time tracking ID | |
| List fields | Retrieve list field details by name | Returns details for all list fields by using name |
Examples
Use templates to quickly create flows for BambooHR
Learn how to use App Connect templates to quickly create flows that complete actions on BambooHR. For example, open the Templates gallery, and then search for BambooHR.
Use IBM App Connect to build flows that integrate with BambooHR.
Read the blog in the IBM Community to learn how to send an email notification on creating an employee in BambooHR. Click Read the blog to go to the blog.