How to generate an API Key in BambooHR

[#1]

Jira Service Management is used not just for ITSM but for non-IT use cases as well. One that is gaining adoption is Human Resources (HR) Service Management. Recently we had an implementation where we needed to integrate with BambooHR. Sharing our lessons learnt so that its useful for rest of the community.

One of the first steps in integrating Jira Service Management with BambooHR, is authentication. BambooHR's APIs relies on API Key. 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.

In BambooHR Admin 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 making calls from Forge or custom code to make REST API calls.

API Key

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

Now that we have the API Key, we can use this to make API calls using Forge API package or any of the Marketplace apps that provide REST API support.

Disclosure: I'm part of Onward. We are the developers of OnLink.