Step 1: Generate API Key in BambooHR

Step 2: Upload BambooHR API Key and Subdomain

Step 3: Confirmation

Some points to consider before integrating:

  1. Departments: Employees will be auto-allocated into their respective teams on the Perkbox platform.

  2. All 'active' people on BambooHR will be added to Perkbox: We do not filter out people who should not receive Perkbox access based on their employment status (i.e. contractor) or their region. However, if you use an additional system with BambooHR, such as Okta or Microsoft Azure, it could be possible. Please speak to your IT for this.

  3. Access level: You might need the highest admin access level from BambooHR to integrate or else it might not work.


Step 1: Generate API Key in BambooHR

Log in to your BambooHR instance as an admin user and select your name in the upper right-hand corner of the BambooHR console, then select “API keys” in the menu.

Select "Add New Key".

Give your key a descriptive name such as perkbox.com and select "Generate Key".

Select "Copy Key" and save this API key, which you'll upload in the next step.


Step 2: Upload BambooHR API Key and Subdomain

Note: You will be able to upload your API Key from the Perkbox platform itself.

Upload the API key you generated in your last step, along with your company's BambooHR subdomain. If you access BambooHR at https://mycompany.bamboohr.com, then the sudomain is "mycompany".


Step 3: Confirmation

Once you have integrated BambooHR, all employees who have never been added to Perkbox will receive their welcome emails immediately.

Did this answer your question?