Prerequisites
Before getting started, please carefully read the following to make sure you fulfill all requirements for the integration to work:
- Your account belongs to the Admins permission group of your company's HiBob instance, or a person whose account belongs to the Admins permission group has shared their access with you. This is necessary for retrieving the API credentials, as explained later in this guide.
To verify that you have access to create API credentials:
- Log into your company's HiBob instance and navigate to the top left corner. Click on the products icon.
- After pressing the products button, a menu will open, and you should see the System Settings option.
If you cannot see the System Settings option, it means that your account does not belong to your company's Admins permission group, and you cannot complete this guide.
Create a new service user
- Log into your HiBob instance (or that of the admin account that was shared with you)
- Click on the link or follow steps 3 and 4 to go to the service user tab of your system settings
-
Go to System Settings > Integration Tools > Service users
- Press Create Service User.
- Enter a display name for the service user, for example, "Acme Integration Service User" and press Create to continue
- You will now be able to view the credentials of the service user. Copy-paste them into the connection flow.
- Choose how you would like to create employees in HiBob – the default option (Regular API) requires no additional configuration.
- (optional) If you selected Hire API in step 8, follow
Creating a permission group
- Go to the permissions settings by clicking on this link, or by pressing the Go to permissions group button in the same dialog that was shown after creating the service user
- Press Create permission group. A menu will open, then press Service user
- Enter a Group name, i.e. "Integration service users".
- In the Select service users section, search for the user that was created on the previous step. The click on Create
- Press Confirm
Configuring necessary permissions for service user
- Click on the People's data tab.
Update the people who are exposed to this permission group. To select all users, press Select people by condition then Edit.
-
Select all available fields (Hired, Employed, Terminated, Garden Leave, Leave, Parental Leave). Click Apply to save the changes.
- After selecting the people this permission group can access, you need to select the specific permissions for the integration. The connection flow will provide a list of all the required permissions for People's data.
Please note: The above is just an example. It will be different in your case. - Under Access data for, locate all of the permissions listed in the connection flow and enable them
- Once all required permissions are selected, click Save in the top right
- You will see a confirmation of all permissions granted; click Apply
Please note: The above is just an example. The listed permissions will be different in your case.
- After having clicked Apply, please wait for roughly 10 seconds. HiBob is still processing your changes, and it typically takes a moment before they are fully updated. After having waited, click on Set up integration in the connection flow
Configuring Hire API
Note: this is only necessary if you selected "Hire API" during the connection flow as the method for creating employees in HiBob.
- Go to the Hire API configuration in HiBob's dashboard.
- Click "+ Add integration"
- Name your integration, choose "Service user" as the authentication method, then add the display name. Finally, click "Generate token".
- Copy the credentials into the connection flow, then click on "Done".
- You should be redirected to a page with the API URL – copy it and paste it into the connection flow as well.
Troubleshooting
Missing permissions!
In some cases, the connection flow may display that you are missing permissions even though they are selected in the HiBob interface. If this is the case, you may need to configure specific field-level access. Please view our guide on this subject below: