HiBob communicated in August 2023 that by March 2024, they will no longer support the use of API keys in their integrations. Instead, they’ll move to Service User Tokens to improve security, performance, and stability.

PayFit has now transitioned to Service User tokens in anticipation of Hibob's transition. You're no longer able to use an API key to link HiBob to your PayFit account.

There are three steps to set up your Service User in HiBob:

Create your Service User.
Set up and assign your Service User permissions group.
Assign the correct permissions to your Service User group.

Once you've completed the three steps, please refer to our HiBob integration Help Centre article for instructions on how to add your Service User ID and Token into PayFit.

Step one: Create your Service User in HiBob

Create your Service User and save a copy of your User ID and token. You won't be able to generate this token again, so it's important to save a copy of it elsewhere. You might need it for other integrations with HiBob, too.

For information about how to do this, please refer to HiBob's Help Centre article.

Step two: Set up and assign your Service User permissions group in HiBob

Warning: Setting up your permission group differently than in the steps listed below can result in colleagues being able to view sensitive data. If you'd like to apply different permissions, please contact HiBob to ensure there's no risk of sharing data with the wrong people.

In HiBob, you need to set up a permission group and assign the correct permissions to this group. To do this:

From the candy box menu in the top-right, click System settings.
Scroll-down the menu on the left, click Account, then Permission groups.
Click Add permission group.
Enter a Group name (e.g. PayFit).
Under the Group members section, choose Select people by condition, then click Select people.

Tip: Here you can also add a condition to filter the employees visible through the integration. For example, you might want to set the condition that the Site Equals United Kingdom for employees to be visible to the service user.
To add the permissions to the user group you've created, under the Add specific employees section, click the drop-down.
Expand the Service user section, select the Service user you set up earlier, then click Apply.
Click Apply, then Create, then Confirm.

Step three: Assign the correct permissions to your permissions group in HiBob

Now that your permissions group has been created, you'll be taken to a page where you can assign the correct permissions.

From the Features tab, use the table below to select the correct permission for each option and section.

Menu option from the left	Submenu	Permission
People	Directory	View the company's people directory.
Time off	Settings	See company's time off settings.

Click the People's data tab, then on the right, check the Lifecycle status equals Any.

Now set the correct permissions using the table below.

Menu option	Section	Permission
People	About	View selected employees' About sections
People	Address	View selected employees' Address sections
People	Basic info	View selected employees' Basic info sections
People	Employment	View selected employees' Employment sections View selected employees' Employment section histories
People	Financial	View selected employees' Financial sections View selected employees' Financial section histories
People	Home	View selected employees' Home sections
People	Identification	Edit selected employees' Identification sections View selected employees' Identification sections
People	Lifecycle	View selected employees' Lifecycle sections View selected employees' Lifecycle section histories
People	Payroll	View selected employees' Payroll sections View selected employees' Payroll section histories
People	Personal	Edit selected employees' Personal sections View selected employees' Personal sections
People	Personal contact details	View selected employees' Personal contact details sections
People	User data	View selected employees' User data sections
People	Work	View selected employees' Work sections
People	Work contact details	View selected employees' Work contact details sections
Time off	Balance	See selected people's time off and sick leave balances
Time off	See who's out today	See who's out because of a private policy. See who's out today

Once you've set the permissions above, click Save, then Apply.

What's next?

Once you've completed the three steps, please refer to our HiBob integration Help Centre article for instructions on how to add your Service User ID and Token into PayFit.

For support in setting up your Service User, please get in touch directly with HiBob. Or for adding your Service User ID and token to PayFit, please get in touch with our Customer Care team.