Table of Contents
Integration with Foresight - How It Works
Pre-Integration Requirements
Step-by-step Guide
Configuring HiBob
Step 1: Create a New API Service User
Step 2: Create a Permission Group and Add the API Service User to It
Step 3: Set Permissions
Step 4: Configure Access Rights
Step 5: Refresh Tokens
HiBob Resources for Configuring API Service Users
Configuring Foresight
Step 1: Authorize and Provide Foresight with HiBob Credentials
Step 2: Start HiBob Integration by Clicking the Synchronize All button
Additional Questions
Do I need to sync new absences manually? How often are absences synchronized?
Integration with Foresight - How It Works
Synchronized Data | Absences: Time Off |
Integration Direction | HiBob ➡ Foresight |
The integration allows you to sync absences recorded in HiBob with Foresight. You can easily sync all absence categories in HiBob with absences in Foresight, reducing staffers' capacity based on the email addresses of your teammates as registered in Foresight.
Pre-Integration Requirements
Pre-Integration Requirements | |
Access | Administrator on both platforms |
Data Synchronization | Users must be added on both platforms using the same email address |
- To integrate Foresight with HiBob, you must have Administrator access on both platforms.
- To sync a specific person's absences, they must be added as a Manager or Staffer in Foresight, using the same email address as in HiBob.
Step-by-step Guide
Integration Checklist | |
1 | Log in to the Administrator Account in HiBob |
2 | Configure HiBob |
3 | Install integration in Foresight Administrator |
4 | Refresh tokens in HiBob and copy credentials |
5 | Paste credentials in Foresight to finalize integrating |
6 | Click the Synchronize All button in Foresight |
- Log in to the Administrator Account in HiBob.
- Configure HiBob by setting up service users and permissions.
- Log in to Foresight with Administrator access and go to the Integrations tab.
- Find the HiBob logo, click the Install button, and follow the on-screen instructions.
- Refresh tokens in HiBob, copy the credentials, and paste them into Foresight to complete the integration.
- Click the Synchronize All button in Foresight to integrate data successfully
Configuring HiBob
Configuring HiBob Checklist | |
1 | Create API service user |
2 | Create a permission group |
3 | Add the configured API service user to the permission group |
4 | Assign specific permissions to the permission group |
5 | Define people from the organization included in the permission group |
Configuring HiBob for integration with Foresight Connect involves several steps:
- Set up an API service user that acts as the connection between Foresight Connect and HiBob.
- Create a permission group to define the level of access Foresight will have to HiBob data.
- Add the configured API service user to the newly created permission group.
- Assign specific permissions to the permission group, including access to features and people’s data.
- Define which people in your organization are included in this permission group (only data from selected individuals will sync with Foresight Connect).
Step 1: Create a New API Service User
Go to the System Settings ➡ Go to the Integrations Tab ➡ Find Automation section on the right ➡ Click Manage button on the Service users tile ➡ Click +Create service user button |
Note: The user creating the service users must be an Admin or should be granted the following permission: Features > Integrations > Automation > Create, update, and delete the integration. |
- From the top left, click Bob products > System settings.
- From the left menu, select Integrations.
- From the All categories dropdown menu, select Automation.
- On the Service users tile, click Manage.
- From the top, click + New service user.
- Enter a display name and a description.
- Click Next.
- The Service user info popup will open. The new API service user's ID and token will be displayed.
- Click Done.
Step 2: Create a Permission Group and Add the API Service User to It
Go to the System Settings ➡ Go to the Account Tab ➡ Go to the Permissions groups subtab ➡ Click +Create permission group button ➡ Select Service user from the ribbon |
By default, service users in HiBob have no permissions, meaning they can't access employee data through the Public API. This may result in empty responses or permission errors when using the API.
To assign permissions to a service user, you need to create a service user permission group, assign the service user to it, and grant the relevant permissions.
Step-by-step instructions
-
Create a Permission Group:
- Go to Bob products > System settings.
- Navigate to Account > Permission groups.
- Click + Create permission group, choose Service user, and name the group.
-
Organize with Tags (Optional):
- Select a tag from the Tags dropdown or create a new one by clicking Edit list.
- Add your tag, then Save and Apply it to the group.
-
Add Service Users to the Group:
- In the Group members section, select the relevant service users and click Apply.
-
Finalize the Group:
- Click Create, review the notification, and confirm by clicking Confirm.
Step 3: Set Permissions
Go to the System Settings ➡ Go to the Account Tab ➡ Go to the Permissions groups subtab ➡ Select the Permission group from the list ➡ Set up permissions in the Features and People’s data sections |
When you create a new permission group, it starts with no permissions assigned. You need to manually select the appropriate permissions.
The instructions below explain which permissions to grant in the Features and People's Data sections.
A. Grant permissions in the Features section:
- Section from the list: Time Off
- Settings
- Manage company’s time off settings
- See company’s time off settings
- Settings
B. Grant permissions in the People's Data section by selecting the following permissions:
- Section from the list: People
- About
- View selected employees’ About section histories
- View selected employees’ About sections
- Address
- View selected employees’ Address section histories
- View selected employees’ Address sections
- Basic Info
- View selected employees’ Basic info section histories
- View selected employees’ Basic info sections
- About
- EEO
- View selected employees’ EEO section histories
- View selected employees’ EEO sections
- Emergency
- View selected employees’ Emergency section histories
- View selected employees’ Emergency sections
- Employment
- View selected employees’ Employment section histories
- View selected employees’ Employment sections
- Equity
- View selected employees’ Equity section histories
- View selected employees’ Equity sections
- Financial
- View selected employees’ Financial section histories
- View selected employees’ Financial sections
- Home
- View selected employees’ Home section histories
- View selected employees’ Homel sections
- Identification
- View selected employees’ Identification section histories
- View selected employees’ Identification sections
- Jobs
- View selected employees’ Jobs section histories
- View selected employees’ Jobs sections
- Lifecycle
- View selected employees’ Lifecycle section histories
- View selected employees’ Financial sections
- Payroll
- View selected employees’ Payroll section histories
- View selected employees’ Payroll sections
- People Analytics
- View selected employees’ People analytics section histories
- View selected employees’ People analytics sections
- Personal
- View selected employees’ Personal section histories
- View selected employees’ Personal sections
- Personal Contact Details
- View selected employees’ Personal Contact Details section histories
- View selected employees’ Personal Contact Details sections
- Temporary Address
- View selected employees’ Temporary Address section histories
- View selected employees’ Temporary Address sections
- Training
- View selected employees’ Training section histories
- View selected employees’ Training sections
- UK Tax Settings
- View selected employees’ UK Tax Settings section histories
- View selected employees’ UK Tax Settings sections
- User Data
- View selected employees’ User data section histories
- View selected employees’ User data sections
- Work
- View selected employees’ Work section histories
- View selected employees’ Work sections
- Work Contact Details
- View selected employees’ Work Contact Details section histories
- View selected employees’ Work Contact Details sections
- Work Eligibility
- View selected employees’ Work Eligibility section histories
- View selected employees’ Work Eligibility sections
- Section from the list: Time Off
- Balance
- Adjust selected peoples’ time off balances and bank their overtime
- Bank overtime on behalf of their employees
- See selected people’s time off and sick leave balances.
- Requests
- Create time off requests through the 'bulk import' function
- Create, edit, and cancel people's requests that haven't been approved yet
- Edit and cancel people's future requests that have been approved
- Edit and cancel people's past requests that have been approved
- Edit attachments, description, and reason in people's requests that have been approved
- View, approve or decline requests that are pending approval of others
- Balance
- See who’s out today
- See who's out based on their personal working pattern and time off calendar
- See who's out because of a private policy
- See who's out today
Step 4: Configure Access Rights
Go to the System Settings ➡ Go to the Account Tab ➡ Go to the Permissions groups subtab ➡ Select the Permission group from the list ➡ Go to the People’s data section ➡ Click Access data for tile placed at the top of the ribbon ➡ Click Edit permissions button at the right top corner ➡ Configure Whose data can members access |
Granting API Access to Employee Data in HiBob
- Go to the People’s Data Tab:
-
- Click Access rights.
- Set Data Access Scope:
-
- Choose whose data the permissions apply to. By default, access is set to all employees using the condition Lifecycle status equals Any.
Options are:
- Everyone: Grants access to all active employees.
- Select by Condition: Click Edit, choose conditions from the dropdown, and click Apply.
- Select by Name: Click Edit, select specific employees, and click Apply.
Tip for Accessing Inactive Employees: To access inactive employees, use the Select by Condition option and remove the default condition Lifecycle status equals Employed from the access rights settings. |
Step 5: Refresh Tokens
Go to the System Settings ➡ Go to the Integrations Tab ➡ Find Automation section on the right ➡ Click Manage button on the Service users tile ➡ Navigate the right service user ➡ Click three dots button on the right and select Refresh token option from the ribbon ➡ In the pop up window click Refresh button to confirm ➡ Copy New token info: Credentials ID and Token ➡ Click Done button |
1. Click Refresh token button from the ribbon:
2. Confirm the action:
HiBob Resources for Configuring API Service Users
If you need additional help with configuring HiBob, we recommend using the following resources in their knowledge base:
- API Service Users - HiBob Knowledge Base: Overview of API Service Users and their purpose.
- Manage Service Users: Step-by-step guide to managing service users in HiBob.
- How-to Create a Service User [Video]: Visual tutorial on creating a service user.
- Create and Update a Service User Permission Group: Instructions on setting up permission groups for service users.
- API Reference Guide: Detailed permissions required for each API endpoint.
Configuring Foresight
Step 1: Authorize and Provide Foresight with HiBob Credentials
Log in to the Administrator Role in Foresight ➡ Go to the Integrations Tab ➡ Find the HiBob integration tile ➡ Click Install button ➡ Paste ID and Token that you copied from HiBob ➡ Click Connect button |
- Find HiBob integration tile on the available integrations list on the right and click Install button:
- Paste credentials copied from HiBob into the fields and click the Connect button to confirm:
Step 2: Start HiBob Integration by Clicking the Synchronize All button
Log in to the Administrator Role in Foresight ➡ Go to the Integrations Tab ➡ Find the HiBob integration tile ➡ Click the Settings button ➡ Click the Synchronize All button and Close |
1. Find the HiBob integration tile and click the Settings button:
2. Click the Synchronize All button to start integrating time off:
Additional Questions
Do I need to sync new absences manually? How often are absences synchronized?
No, you don’t. Foresight automatically syncs absences every 24 hours, ensuring your data is always up-to-date.