Skip to content

HiBob API Integration

HiBob is a provider of cloud-based human capital management (HCM) solutions to employers. HiBob-API will use HiBob Rest API to fetch all the employees’ data.

Create a Connection

Hire2Retire requires the following details to create a connection with your HiBob server:

  • Connection Name - A user-defined nomenclature for your connection. By default, the connection name is "Connection-OAuth Client Cred", you can change the name as per your preference.

  • Service ID - This is the application service ID to interact with HiBob API. You will get the service ID created at the time of your registration on HiBob portal.

  • Token - This is the application token to interact with HiBob API. You will get the token created at the time of your registration on HiBob portal.

Connection page

Figure 1. HiBob API Connection Set Up page - Create Connection

Create the Service User in your Hibob Account

1. In settings, go to integrations and click Manage Service Users.

Connection page

Figure 2. HiBob API connection service user

2. Create a new Service User and save the Service User ID and Token

3. Back in your settings, go to Permission Groups and select Create Group.

Connection page

Figure 3. HiBob API connection groups creation

4. Name the group, then, in the Group members section, choose Select people by condition and select Edit.

Connection page

Figure 4. HiBob API connection select members

5. In the Select people by condition pop-up, delete the existing condition and add the Service User previously created in the dropdown menu for Add Specific Employees then click Apply.

Connection page

Figure 5. HiBob API connection conditions

6. Finish the initial creation of the Group by selecting Create. If a pop-up appears, Confirm the creation of the group.

Connection page

Figure 6. HiBob API connection methods

7. Under People's Data, edit the data that can be accessed by choosing Select people by condition and selecting Edit.

 a. Click Select by Condition

 b. Click Edit

 c. Lifecycle Status = Employed, Hired, Terminated

8. Under People's Data add the following permissions.

  1. About > View selected employees' About sections

  2. Basic Info > View selected employees' Basic info sections

  3. Address > View selected employees' Address sections

  4. Employment > View selected employees' Employment sections

  5. Employment > View selected employees' Employment section histories

  6. Home > View selected employees' home sections

  7. Identification > View selected employees' Identification sections

  8. Personal > View selected employees' Personal sections

  9. Personal Contact Details > View selected employees' Personal contact details sections

  10. User Data > View selected employees' User data sections

  11. Work > View selected employees' Work sections

  12. Work Contact Details > View selected employees' Work contact details section

Please note the permissions below are the required permissions for the full HRIS API. You only need to configure the permissions based on your use case.


Once you have successfully configured the connections, you can continue with the Design section to configure the rest of the workflow following these steps in order.

  1. HR Employee Data Definition
  2. Lifecycle Business Rules
  3. Employment Status
  4. HR to AD Profile Map
  5. Organizational Unit Assignment - Only defined in on-premise Active Directory
  6. Security Group Assignment
  7. Distribution List Assignment


Once your workflow has been setup, you can optionally setup notifications and archival for your workflow.

Otherwise, you can proceed to deploy and test it on the Hire2Retire platform, see Deploy and Test Flow