Skip to main content

BambooHR Connection

The goal of this document​

Here, we are going to connect the vendor called BambooHR to the Airbyte, then it will redirect the data using the destination of MySQL, User can choose the format of the destination as required, For example from MySQL/ PostgreSQL, etc.

Useful Resources of Airbyte​

Requirements to get the ‘bamboohr’ source​

Steps to Fetch the subdomain and API-key from bamboohr.com​

  1. To getch the Access Token of bambooHR, you should go to https://www.bamboohr.com/.
  2. After signup, you need to login with your credentials.

Docusaurus Slash Introduction

  1. Now find subdomain and API key. go to the top-right corner and click on settings icon:

  2. From the settings window, you will get the subdomain, as shown in the figure below:

Docusaurus Slash Introduction

  1. Now, Click on the account profile icon and find API-keys option, as shown in the figure below:

Docusaurus Slash Introduction

  1. You will land on API window, now click on Add New Key to create new API key:

Docusaurus Slash Introduction

  1. Add required name of your API key, as shown in the figure below:

Docusaurus Slash Introduction

  1. As you click on the Generate key button, the API key will be added under the name, as shown in the figure below:

Docusaurus Slash Introduction

  1. Click on copy key button to copy the API key.

Steps to Connect bamboohr.com with AIV​

  1. Go to the Airbyte using the below link: https://airbyte.com/

  2. The Airbyte landing screen looks like below:

Docusaurus Slash Introduction

  1. Here We have 3 options on the left, which contain Connections, Sources, and Destination. As per continuing the steps click on the Sources option.

Docusaurus Slash Introduction

  1. To add the bambooHR source, click on the New Source button from the Top-right corner.

Docusaurus Slash Introduction

  1. To add Any of the sources here, the user needs to add the properties which are needed from the Airbyte, every source has its own individual properties.

Docusaurus Slash Introduction

note

Note: Here, every source demands a different type of property, where API key, Client Id, Client Secret, and Refresh Tokens are common in most sources. on that we can say, all the sources are different from each other.

  1. Set up source Form overview:
  • Name: Users can add the name of the source as per their requirements.
  • Source Type: The user has to select the source type from the provided list by airbyte.
  • API key: Add the APi key here which you got from the bamboohr.
  • Subdomain: Add subdomain of your bamboohr profile.

Docusaurus Slash Introduction

  1. Now, set up the source here,
  • Add the name as BambooHR,
  • Select BambooHR from the source,
  • Add API Key in the setup form,
  • Add subdomain in the setup form,
  • Validate your form with as shown in the figure below:

Docusaurus Slash Introduction

• Now, click on Set up Connection, it will test the connection here, then it will redirect to add destination of the source, as per figure below:

Docusaurus Slash Introduction

  1. After testing the connection successfully add the destination here.

Docusaurus Slash Introduction

Here, on the source adding screen,

  • The top-menu bar shows two buttons where 1. for Overview of the source and 2. for the settings of the source.
  • Overview: The overview screen shows the details related to the source; it may be empty as per the above screen.
  • Settings: From settings, the user can edit the form details of the added source.
  • Add destination button leads us to the destination page from this source page.
  1. Click on the Destination from the Top-right corner, as shown in the figure below:
note

It’s will show the available destinations, here user can add the new destination as per required.

Docusaurus Slash Introduction

info

To know more about adding the required destination in Airbyte go to the Destination

  1. Click on the MySQL Training here. it may take some time to fetch the stream names, as shown in figure below:

Docusaurus Slash Introduction

  1. After loading all the Streams form the Vendor’s to the destination, the destination page looks as shown in the figure below:

Docusaurus Slash Introduction

  1. After loading all the data streams user need to add Sync frequency and Table Prifix, as shown in the figure below:

  • Add Sync Frequency: Manual

  • Add Table Prefix: freshdesk_

  • When the user add the prefix, it gets added on Destination stream name automatically, as shown in the figure below:

Docusaurus Slash Introduction

  1. At the bottom of the destination page, we have two radio buttons, which contain the Normalization option. Keep the Basic Normalization selected.

Docusaurus Slash Introduction

  1. Now, click on the setup connection button to complete the connection. it will test the connection again which may take some time.
  2. Now, to validate the data is synced by the Airbyte, Go to the Connection from the Left menu bar of the screen:

Docusaurus Slash Introduction

  1. Find the Added connection of the BambooHR from the list,

Docusaurus Slash Introduction

Here, the Data isn’t synced yet, for that it shows the icon of non-sync at the start of the row. click on the row to see the details.

  1. Here the BambooHR connection page will show the Status of the data sync and sync history.

Docusaurus Slash Introduction

  1. The title of the Source and destination name.
  2. Status and settings page top menu bar.
  3. Enable button: from this button, the user can enable/disable the source from the destination.
  4. Reset your data and Sync button: the user can reset their data and only sync the updated data from the vendor.
  1. Click on the sync button to sync the data manually, after clicking on the sync button it will start the process which will indicate the status under the history grid as shown in the figure below:

Docusaurus Slash Introduction

info

Once it gets completed it will indicate as the Succeeded under the history, as it will also indicate the size of data records number and time of sync. Here we have added the sync time as every hour, on that the Airbyte will sync the data in every hour automatically which will be shown as the figure below:

Docusaurus Slash Introduction