Connectors / Service / BambooHR

BambooHR

BambooHR

BambooHR is a cloud-based human resources (HR) software service for small and mid-size businesses.

Overview

BambooHR is an American technology company that provides human resources software as a service. BambooHR's services include an applicant tracking system and an employee benefits tracker.

Authentication

When using the BambooHR connector, the first thing you will need to do is go to your Tray.io account page, and select the workflow you wish to work on. Once in the workflow dashboard itself, search and drag the BambooHR connector from the connectors panel (on the left hand side) onto your workflow.

With the new BambooHR connector step highlighted, in the properties panel on the right, click on 'New Authentication' which is located under the 'Settings' heading.

This will result in a Tray.io authentication pop-up window. The first page will ask you to name your authentication appropriately, and state which type of authentication you wish to make ('Personal' or 'Organisational').

As you can see, the next page asks you for your 'API Token' and 'Subdomain'.

To generate an API key, users should log in and click their name in the upper right-hand corner of any page, to get to the user context menu. If they have sufficient permissions, there will be an "API Keys" option in that menu to go to the page.

Name and generate your new API key - make sure to copy it carefully as viewing it again (for security reasons) will not be possible.

Your subdomain can be found within the first section of your URL:

Copy these important pieces of information directly into your Tray.io authentication popup.

Once you have clicked the 'Add authentication' button, go to back to your authentication field (within the workflow dashboard properties panel from earlier), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Example usage

TRAY POTENTIAL: Tray.io is extremely flexible. By design there is no fixed way of working with it - you can pull whatever data you need from other services and work with it using our core and helper connectors. This demo which follows shows only one possible way of working with Tray.io and the BambooHR connector. Once you've finished working through this example please see our Introduction to working with data and jsonpaths page and Data Guide for more details.

The instructions below will take you through how to add, update and get an employee.

The steps will be as follows:

  1. Setup using a manual trigger and use the first BambooHR connector to add a new employee.
  2. Use the next step to update said employees details.
  3. Finally get the details available on said employee.

The final outcome should look like this:

1 - Setup trigger & Add Employee

Once you have clicked 'Create new workflow' on your main Tray.io dashboard (and named said new workflow), select the Manual trigger from the trigger options available:

Once you have been redirected to the Tray.io workflow dashboard, from the connectors panel on the left, add a BambooHR connector to your second step. Set the operation to 'Add Employee'.

In order to complete this step you will need to fill in some basic details, mainly their name and location.

Feel free to re-name your steps as you go along to make things clearer for yourself and other users.

Now when you run your workflow, a new employee will have been created.

2 - Update Employee

Add a second BambooHR connector to your workflow and set the operation to 'Update Employee'.

You will need your employee ID in order to compelte setup. The easiest and simplest way of gathering this information is to use the connector-snake. Drag the snake from your 'Employee ID' field, over the previous connector step. When you do so, a new list of options will appear. Select the data listsed as id.

Your results should be similar to: $.steps.bamboohr-1.id

JSONPATHS: For more information on what jsonpaths are and how to use jsonpaths with Tray.io, please see our Intro page and Data Guide for more details.
CONNECTOR-SNAKE: The simplest and easiest way to generate your jsonpaths is to use our feature called the Connector-snake. Please see the main page for more details.

In order for this connector to work effectively you need to add a field option:

In this example, the field we choose from the dropdown options available is 'status' and the 'Value' is set to be changed to 'Active'.

Now when you run your workflow, the employee you specified will have an updated status!

3 - Get Employee

Add a final BambooHR connector to your workflow and set the operation to 'Get Employee'.

Use the connector-snake once more to generate the 'Employee ID' field from earlier.

Add the BambooHR information fields you wish to gather on your chosen employee. Again choose form the dropdown options available.

Now when you run your workflow, you will see within your Debug panels that not only have you created and updated your new employee, but also have the information you requested available to you!

BEST PRACTICES: Whenever you do decide to create your own workflow, please make sure you take a look at our Managing data best practices guide.

All Operations

Latest version:

2.0