Enabling and using the BambooHR integration

Follow
Available for User roles Super Admins
Packages Select Lever packages

As an official BambooHR partner, Lever makes it easy to automatically push hired candidates from Lever to BambooHR. Streamline the recruiting to HR process through the pre-population of fields in BambooHR for new hires by sending candidate, offer, requisition, and profile data from Lever when candidates are hired. The Lever-BambooHR integration will automatically populate a new BambooHR employee profile, minimizing the time spent on manual data entry.

 

Field mapping

The BambooHR integration pulls candidate details from a variety of locations in Lever. Read through our BambooHR field mapping help article which describes how data from various Lever objects can be configured and mapped to maximize how much data is sent to BambooHR.

Lever's enhanced integration with BambooHR supports passage of the following fields:

  • First Name
  • Last Name
  • Preferred Name
  • Mobile Phone Number
  • Home Email
  • Job Title
  • Division
  • Department
  • Location
  • Address 1
  • Address 2
  • City
  • State
  • Zip Code
  • Country
  • Hire Date
  • Pay Type
  • Pay Rate Currency
  • Pay Rate
  • Job Info Effective Date
  • Employment Status
  • Employment Status Effective Date

 

Enabling the BambooHR integration

 

The BambooHR integration must be configured by a Super Admin on your Lever account and a Full Admin user on the BambooHR account. If the BambooHR key is configured by a user other than a full admin, you may not see all Lever data pre-populated in your BambooHR instance.

Enable the BambooHR integration in Lever

Navigate to Settings > Integrations and API and toggle on the BambooHR integration.

BambooHR integration toggle in Lever integration settings.

When you toggle on the BambooHR integration, please read through the accompanying integration details, then click the button Send Request to Enable button to notify Lever Technical Support of your request.

BambooHR integration tile with send request to enable button circled.

Lever will reach out to you requesting the following required information:

  • BambooHR Company URL - Be sure this is an EXACT match with the spelling you use for your BambooHR account (e.g. https://:COMPANY.bamboohr.com/)
  • BambooHR API Key - This key should be generated by a full admin user from your BambooHR dashboard (Details below)

 

Configuring the BambooHR integration

Creating an API Key

 

We recommend that you create a non-employee user in your BambooHR instance with Full Admin access to create the API key (such as integration@yourcompany.com). Although this is not required, doing so will assure that the integration continues to operate successfully in the event that your admin users depart or have access role changes.

To generate a BambooHR API key:

  • Log into BambooHR then click on your account icon in the top right-hand corner of the dashboard menu and select API Keys.

Settings menu in BambooHR with API keys option circled.

  • Next click on the + Add New Key button in the My API Keys window.

My API keys page in BambooHR with Add New API key butotn circled.

  • In the API Key Name text box, type "Lever" then click the Generate Key button.

Add New API key modal with Lever type in API key. name field and Generate New Key button circled.

  • Click on the Copy Key link and save the API key in a document you can easily access. Once complete, click the Done button. You will provide this API key to Lever as a part of your configuration.

Same modal as previus image post-key generate with copy key and Done buttons circled.

 

Creating a BambooHR employee profile record from Lever

Once the integration has been configured you can begin sending data from Lever to BambooHR when candidates are hired. The integration will create a new BambooHR employee profile record.

Candidate preparation

Before hiring the candidate, make sure that all desired fields are filled out on the candidate, requisition, offer and BambooHR New Hire profile form. The more fields present and populated in Lever, the more fields that will be pre-populated in BambooHR.

Candidate profile in Lever

Lever Profile and Offer forms. Job title field is circled on Offer form. Note beneath image reads that outlined values must exactly match the BambooHR values.

Associated Requisition in Lever with location, work type and department/team fields circled.Note beneath image reads that outlined values must exactly match the BambooHR values.

Hiring a candidate

Once the candidate details have been filled out, you may then archive the candidate as 'Hired' in Lever. At a minimum, First Name, Last Name, and Home Email are required to create a record in BambooHR.

Candidate profile in Lever with opportunity archived as 'Hired.'

A new employee record will be created in BambooHR.

Employee record in BambooHR with close-up of pre-populated fields.

The associated Job Info, Employment Status and Salary details will also be included in the new BambooHR employee record.

Employee record in BambooHR showing additional fields on visible in previous image.

New stories will appear on the candidate profile page in Lever with the BambooHR ID, notifying the opportunity owner that the candidate was transferred over successfully.

Candidates story in Lever with new stories listing BambooHR notifications.

What if I don't want to send a candidate profile to BambooHR?

You are able to prevent candidate profiles from being pushed through the integration by applying the tag 'BambooHR New Hire - Skip' to the candidate profile prior to archiving the candidate as 'Hired.'

 

Resume and offer upload to BambooHR

In addition to triggering off the Hired archive state and passing candidate information the integration has been updated to also:

  • Pass resume, if available
  • Pass the candidate offer file

Both actions will be completed via the BambooHR API. Inputs required from the client to set up file upload from Lever to BambooHR are as follows:

Field Notes
Model Emp ID Integer field. The ID given by the client will be used in getting the metadata for folders. This corresponds to the client's employee ID or number as it appears in BambooHR.
Offer Resume Folder Name If TRUE, the solution will need to know the folder to upload to in the client's system as every BHR instance may vary in the file structure.
Offer Letter Folder Name If TRUE, the solution will need to know the folder to upload to in the client's system as every BHR instance may vary in the file structure.

 

Expected notes for file uploads will be created as follows:

Type Format
Success notification

@ownerUsername, New Hire successfully transferred and files successfully uploaded to BambooHR.

\n\n

New Hire: bambooHRNewHireURL

Failure notification

@ownerUsername, New Hire failed to transfer and files failed to upload to BambooHR.

\n\n

HTTP Status: API_RESPONSE_HTTP_CODE_AND STATUS

\n

Message: API_RESPONSE_MESSAGE

 

Example of success notification:

@lever, New Hire successfully transferred and files successfully uploaded to BambooHR.

BambooHR: 

https://api.bamboohr.com/api/gateway.php/leverpartnerintegrationsandbox/v1/employees/129

Example of failure notification:

@lever, New Hire failed to transfer and files failed to upload to BambooHR.

HTTP Status: 400 Unauthorized

Message: The security token you passed has expired.

Was this article helpful?
0 out of 0 found this helpful