> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Connecting BambooHR to Neo

> Create a BambooHR API key for a client and save it in Neo

You connect BambooHR once for each client that uses it, with two values for that client's BambooHR company: the company domain and an API key.

## 1. Create an API key in BambooHR

A user in the client's BambooHR does these steps. Every call Neo makes runs with that user's BambooHR access level, so Neo sees and changes only what the user can.

**1. Pick the user**

Use a BambooHR user who can see the employees and fields your agents work with, such as a user with full admin access, or a dedicated user for Neo with a custom access level. To have Neo write back a work email, the user's access level must allow editing it.

**2. Create the key**

Signed in as that user, click the user's name in the lower left corner of BambooHR, then **API Keys**, and add a key named `Neo`. Copy the key when BambooHR shows it.

**3. Find the company domain**

The company domain is the part before `.bamboohr.com` in the client's BambooHR address. For `https://acme.bamboohr.com`, it is `acme`.

## 2. Add the connection in Neo

**1. Open Integrations**

In the Neo Dashboard, open [**Integrations** → **BambooHR**](https://dashboard.neoagent.io/integrations?open=bamboohr), under HR & Business Apps.

**2. Pick the client**

In **Customer**, choose the client this BambooHR company belongs to. The client must be on your **Companies** tab. For a second client, click **Add customer**.

**3. Save the connection**

Enter the **Company Domain** and the **API Key**, and click **Save settings**. Neo reads the client's BambooHR field list with the key before it saves, so a wrong value is rejected straight away, with what to fix.

> [!WARNING]
>
> When the key's user is deactivated, or someone deletes the key in BambooHR, Neo loses access to that client's BambooHR until you save a new key here. BambooHR also pauses API access for a while after repeated tries with a wrong key.

## 3. Turn BambooHR on per agent

**1. Open the agent's tools**

Open the agent in the Neo Dashboard, go to its **Tools & Settings** tab and click **HR & Business Apps**.

**2. Pick a preset**

Expand the **BambooHR** block and pick one of its **Presets**, or set each permission group by hand.

| Preset | What it does |
| - | - |
| **Read Only** | Reads employees, time off, time tracking, talent and onboarding, custom fields, company settings and webhooks; changes nothing |
| **Helpdesk** | Reads the same; a change to an employee's record or custom fields asks a technician |
| **IT Admin** | Changes employees, time, talent, custom fields and settings on its own; a webhook write asks a technician |
| **Full Automation** | Every BambooHR call Neo sends, in every group; only creating or changing a webhook, or naming a compensation planning cycle's admins or approvers, asks a technician |

Read Only, Helpdesk and IT Admin keep **Personal Details**, **Compensation & Benefits**, **Files** and **Reports & Datasets** off. Turn one on only for an agent that needs it.

## 4. Start work from HR changes

To have Neo act when HR adds an employee or changes their title, manager or name, set up a scheduled agent that runs every hour or each morning. It asks each client's BambooHR who was added or changed since its last run, reads each employee's record, and creates or updates their Microsoft 365 account, or opens the ticket your other agents work. Ask your Neo Support Agent to set it up, and say which clients, how often, and what Neo does for a new employee and for a change.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.