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

# HiBob

> Connect each client's HiBob account to Triggr with a Bob API service user.

Triggr automates HR-driven onboarding and offboarding in HiBob (Bob): creating, inviting, updating and terminating employees, and working with their history, time off, tasks and reports.

You need Bob Admin access to each client's Bob account, or a Bob Admin at the client who can send you the service user's ID and token.

## Set up HiBob

Do this in each client's Bob account, and in your own if you use Bob.

**1. Create a service user**

In Bob, go to **Settings > Integrations**, select Automation and click Manage on the Service users tile, then click **New service user**, name it, click Next and copy the ID and Token. Bob shows the token only once. See HiBob's [API service users](https://apidocs.hibob.com/docs/api-service-users).

**2. Add it to a permission group**

In **Settings > Account > Permission Groups**, create a group such as `Triggr API` and add the service user. See HiBob's [Create a service user permission group](https://help.hibob.com/hc/en-us/articles/29550415706897).

**3. Grant permissions**

A new group has nothing enabled. Grant what your workflows need from [Permissions for each action](#permissions-for-each-action):

* Features: click **Edit** and tick the permissions.
* People's fields: click Edit permissions, open People's data > People's fields and enable View, Edit or View history.
* Access data for: on the People's data tab, choose Everyone, Select people by condition or Select people by name.

> [!TIP]
>
> For offboarding workflows that touch terminated employees, choose Select people by condition and remove the Lifecycle status equals Employed condition.

## Permissions for each action

Bob leaves fields the service user can't see out of responses without warning. See HiBob's [Permissions](https://apidocs.hibob.com/reference/permissions) and [Categories and permissions](https://apidocs.hibob.com/docs/categories-and-permissions).

> [accordion] Employees and lifecycle
>
> | Triggr actions | Permission |
> | - | - |
> | Search Employees, Get Employee, List Public Profiles | View under People's fields on each category read. Default fields need `root`, `about`, `employment` and `work`. |
> | Create Employee | Features > People > Add new people to the company, plus Edit on the categories you set |
> | Update Employee, Update Employee Email | Edit on the fields or categories changed |
> | Terminate Employee | Edit on Lifecycle (Table) under People's fields |
> | List Onboarding Wizards | Features > Settings > 'Welcome' flow > Customize the welcome flow |
> | List People Fields, List Named Lists, Get Named List | None |
> | Add Named List Item, Update Named List Item | Features > People > Edit all lists (sites, job titles, etc.) |
>
> Sensitive fields, such as full date of birth, need both View and Edit. For Invite Employee, Revoke Employee Access, Set Employee Start Date and the avatar actions, see HiBob's [People API](https://apidocs.hibob.com/reference/people).

> [accordion] Employee history and custom tables
>
> | Triggr actions | Permission |
> | - | - |
> | Get Work History, Get Employment History, Get Lifecycle History, Get Salary History and their Bulk versions | View history on the category (Work, Employment, Lifecycle (Table) or Salary (Table)), plus View on the category or columns |
> | Create Work Entry, Create Employment Entry | Edit on Work or Employment |
> | List Custom Table Metadata, Get Custom Table Entries, Create Custom Table Entry | View on the table's category to read, Edit to add rows |

> [accordion] Time off
>
> All under People's data > Time off unless marked Features.
>
> | Triggr actions | Permission |
> | - | - |
> | Get Whos Out, Get Out Today, Get Time Off Changes | See who's out today > See who's out. For private requests, also See who's out because of a private policy or policies with a custom name. For pending requests, also Requests > Create, edit all fields, and cancel people's requests that haven't been approved yet. |
> | Get Time Off Request | See who's out, plus Requests > Create, edit, and cancel people's requests that haven't been approved yet |
> | Submit Time Off Request | Features > Time off > Settings > Manage company's time off settings, plus Requests > Create, edit, and cancel people's requests that haven't been approved yet |
> | Cancel Time Off Request | Requests > Create, edit, and cancel people's requests that haven't been approved yet |
> | Get Time Off Balance | Balance > See selected people's time off and sick leave balances and Adjust selected people's time off balances and bank their overtime |
> | List Policy Types, Get Policy Type | Features > Time off > Settings > Manage company's time off settings |
>
> See HiBob's [Time off permissions](https://apidocs.hibob.com/reference/time-off).

> [accordion] Tasks and reports
>
> | Triggr actions | Permission |
> | - | - |
> | List Open Tasks, List Employee Tasks, Complete Task | People's data > Tasks and flow > People's tasks > View and mark selected people's tasks as complete or incomplete |
> | List Company Reports, Download Report | Features > Reports > View reports according to people's data access rights, plus access to the report's data |

## Connect it in Triggr

Per-client integrations never fall back to the Base Configuration, so every client whose workflows use HiBob needs its own configuration.

**1. Open the client's row**

Go to **Integrations > HiBob** and click Configure on the client's row in the Per-Client Configuration card (or on the Base Configuration card for your own Bob account).

![The Per-Client Configuration card listing Acme Corp and Globex, each Not Configured with Admin Consent Not Required and a Configure button.](https://mintcdn.com/triggr/nyuVXZ1rouDTTEvu/images/integrations-common/per-client-configuration.png?fit=max\&auto=format\&n=nyuVXZ1rouDTTEvu\&q=85\&s=11464b4946bea0b580c73330d9114a41)

**2. Enter the service user**

Enter the Service User ID and Service User Token from the live Bob account (not a sandbox), then click Save Configuration.

![The HiBob configuration window with Service User ID and Service User Token fields, an Allow insecure TLS switch under Advanced, and a Save Configuration button.](https://mintcdn.com/triggr/nyuVXZ1rouDTTEvu/images/hibob/configure.png?fit=max\&auto=format\&n=nyuVXZ1rouDTTEvu\&q=85\&s=7362bb0a3fa114449ca6ecb52b1edef5)

In workflows, most actions take the employee's Bob ID, which Search Employees returns as `root.id`. Search Employees returns active employees only unless `jsonBody` includes `"showInactive": true`. Create Employee needs `firstName`, `surname`, `email`, `work.site` and `work.startDate`.

## Troubleshooting

> [accordion] no HiBob integration is configured for this client
>
> Configure the client on the Per-Client Configuration card.

> [accordion] Authentication errors (401)
>
> Check the ID and token are complete and not swapped, and that the token hasn't been regenerated. To replace a token, generate a new one in Bob and click Edit on the configuration.

> [accordion] Permission errors (403), or missing fields or employees
>
> Add the permission from [Permissions for each action](#permissions-for-each-action). Missing employees are outside Access data for, or inactive.

> [accordion] Rate limits (429) or temporary blocks
>
> Creating, updating and terminating employees are limited to 10 requests a minute, and searching to 50. Bob also blocks requests for five minutes after more than 50 failed requests in ten seconds. See HiBob's [Rate limiting](https://apidocs.hibob.com/reference/rate-limiting).


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