Skip to main content

Authorization

Follow this guide to create a new BambooHR credential that will allow Nexla to authenticate to and exchange data with your BambooHR account.
bamboohr_api_auth.png

Bamboo HR

Prerequisites​

Before creating a BambooHR credential in Nexla, you need to obtain your API key from your BambooHR account. BambooHR uses Basic Authentication with an API key for secure API access.

BambooHR API Key Setup​

BambooHR API keys provide secure, programmatic access to your BambooHR account data. API keys are used together with Basic Authentication to authenticate API requests.

  1. Access BambooHR: Sign in to your BambooHR account.

  2. Navigate to API Settings: Click on your account settings or profile icon, and navigate to API or Integrations settings. The exact location may vary depending on your BambooHR account configuration and permissions.

  3. Create or View API Key: If you don't have an API key, create a new one. If you already have an API key, you can view it in the API settings. API keys are typically long alphanumeric strings.

  4. Identify Company Subdomain: Note your company's BambooHR subdomain. This is the subdomain used to access your BambooHR account. For example, if you access BambooHR at https://mycompany.bamboohr.com, then your subdomain is mycompany.

  5. Copy API Key: Copy your API key immediately after viewing it. Keep the API key secure, as it provides access to your BambooHR account data.

    BambooHR API keys provide programmatic access to your BambooHR account. Keep your API key secure and do not share it publicly or commit it to version control systems. If you suspect your API key has been compromised, regenerate it immediately in your BambooHR API settings. For detailed information about creating and managing API keys, see the BambooHR API documentation.

For additional information about BambooHR API authentication and credential management, see the BambooHR API documentation.

Create a BambooHR Credential​

  • To create a new BambooHR credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – BambooHR

BambooHRCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

BambooHR API Configuration​

  1. Enter your company's BambooHR subdomain in the Company Sub Domain field. This should be the subdomain used to access your BambooHR account. For example, if you access BambooHR at https://mycompany.bamboohr.com, enter mycompany. The subdomain is used to construct the API endpoint URL for your account.

  2. Enter your BambooHR API key in the API Key field. This should be the API key obtained from your BambooHR account API settings. The API key is used as the username for Basic Authentication, together with a random string password for secure API access.

    The API key provides secure access to your BambooHR account data through the API. The API key is used as the username for Basic Authentication, and a random string password is automatically generated for each request. Keep your API key secure and do not share it publicly or commit it to version control systems. For detailed information about BambooHR API authentication, see the BambooHR API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.