> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.superpath.io/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# How to Connect and Configure HiBob (oAuth)

# How to Connect and Configure HiBob

The SuperPath HiBob integration is a great way to connect your HiBob system to SuperPath to keep your people and teams in sync and have the employee training record sync back into HiBob

You can also mirror your HiBob Skills catalogue into SuperPath, and push the certificates your people earn into their HiBob training record. Both are optional and are turned on with the **Sync skills** and **Sync certificates** options described below.

The following video takes you through the configuration
${frame}[](https://www.loom.com/embed/9ab6b27548a84029a0b3c7783e498b4a)


## What do you need to configure the HiBob integration?

The following is needed to configure the HiBob integration:
* user MUST be an Admin in SuperPath
* user MUST be an Admin in HiBob

## What actions can the HiBob integration perform?

The HiBob integration can be configured to perform the following actions.  Each of these actions can be turned off or on depending how you would like to configure your integration.  

###### Keep your people record in sync
When you update an employee in HiBob it will update the employee details in SuperPath. This includes employee name, any teams (if configured below) and manager. It will also disable employees in SuperPath if they are terminated or disabled in HiBob. The sync runs every 30 minutes

###### User Creation Options
SuperPath offers seven options for how to create users when connecting a HRIS platform
* **Manual** - In this option users will NOT be created and will have to be created or invited manually.  Once added the user records will be kept in sync through updates from HiBob
* **Invite Users** - In this option users will be invited to the platform when triggered from HiBob.  Users will only appear in SuperPath once they have accepted their invite.  This is the option to use when wanting to use Google or MSFT SSO options
* **Create with Password** - In this option the user will be created in SuperPath with a password.  The user will not be notified.  You can send a welcome email using the Send Welcome button in the People list which will send them their password.  Alternatively they can use the forgotten password flow.
* **Create with Magic Link** - In this option the user will be created in SuperPath with a magic link.  The user will not be notified unless Send Welcome Email is activated.  You can also send a welcome email using the Send Welcome button in the People list.  This user will be able to access SuperPath using a magic link - https://help.superpath.io/en/article/how-to-login-using-magic-link-1ghozvh/
* **Create with Google** - In this option the user will be created in SuperPath and marked to authenticate with Google.  The user MUST authenticate to SuperPath with the Google account matching that email.  The user will not be notified unless Send Welcome Email is activated.  You can also send a welcome email using the Send Welcome button in the People list.  
* **Create with Microsoft** - In this option the user will be created in SuperPath and marked to authenticate with Microsoft.  The user MUST authenticate to SuperPath with the Microsoft account matching that email.  The user will not be notified unless Send Welcome Email is activated.  You can also send a welcome email using the Send Welcome button in the People list.  
* **Create with SAML** - In this option the user will be created in SuperPath and marked to authenticate with SAML.  The user MUST authenticate to SuperPath with the SAML configuration that has been setup within SuperPath - https://help.superpath.io/en/article/how-to-connect-saml-sso-1nf8n4q/

###### Company user creation
If your workforce is a mix of office staff on a company email address and contractors or casuals on personal addresses, you can set a second authentication type that applies only to your company email domain.  Set **Company user creation** to the method you want for your company staff, enter your domain in **Company email domain**, and everyone else keeps the option you chose above.  A company domain match takes priority over every other option, including Manual and Invite Users.  See [How to Set a Second Authentication Type for Company Staff](https://help.superpath.io/en/article/how-to-set-a-second-authentication-type-for-company-staff-hp1o58/).


###### Restrict Employee Sync By Sites
It's possible to ONLY sync users from specific sites in HiBob.  Enter the sites (separated by comma, no spaces).  If left empty all sites will be synced

###### Add completed learnings to the employee record
When a person completes a learning (learning pathways and learning assignments) the learning will be pushed to the Employees training record in HiBob.  Please note you will need to have purchased the training module for HiBob.

###### Sync skills
Mirror your HiBob Skills catalogue into SuperPath, so you can attach the skills you already maintain in Bob to your learning content instead of re-keying them. You create a report in Bob named exactly **SuperPath - Skills Catalogue** and SuperPath reads it once a day, creating, updating and archiving skills to match. Synced skills are read-only in SuperPath and are managed in Bob. Full setup steps are in "How to Sync Your HiBob Skills Catalogue".

###### Sync certificates
When a person earns a certificate in SuperPath it will be added to the employee's training record in HiBob, using the certificate's name and the date it was awarded. The certificate PDF is uploaded to the employee's shared documents in Bob and linked from the training record's **Doc** column. Because HiBob training records have no expiry field, an expiring certificate has its expiry date included in the record's description instead. Deleting the certificate in SuperPath removes the matching training record from HiBob.

## Additional actions

You can also perform the additional actions after you have connected HiBob

* **Refresh People and Teams** - Sync all employee records from HiBob into SuperPath.  This process will invite new HiBob employees to SuperPath, update existing users in SuperPath
* **Sync skills now** - Mirror your HiBob Skills catalogue into SuperPath immediately, rather than waiting for the daily sync. Requires **Sync skills** to be turned on
* **Learning Resync** - Backfill completed learnings, and earned certificates, that have not yet reached HiBob. Useful straight after turning on **Sync certificates**, to bring historic certificates across. Running it again is a no-op
* **Reconnect** - Run the HiBob sign-in again without deleting the integration. Your settings, sync options and site restrictions are all kept. Use it if the connection has expired, if HiBob has been reinstalled, or if you need to grant the app a permission it was not given the first time

## How to Connect HiBob

You can connect to HiBob and SuperPath using a secure authentication flow.  Please make sure you are an administrator in HiBob.  

1. In SuperPath got to Settings->Integrations
2. Click the HiBob and select View Details
3. Select the User Creation option (see above)
4. Select welcome email option (if on it will email users when they are created in SuperPath.  We recommend to keep this off, and email them when they are assigned their first learning)
5. Choose whether to sync learning records back into HiBob, and whether to turn on **Sync skills** and **Sync certificates** (see the actions above)
6. If you wish to restrict the sync to only specific sites you can enter the sites.  If not, leave empty.
7. Click Connect Bob and follow instructions to accept and ONLY check the boxes listed below in required app permissions
8. Once connected you can test your connection.

### Required App Permissions
When connecting HiBob please ONLY check the options listed below:

**View Employee Data**
* View selected employees' Work sections
* View selected employees' Basic info sections
* View selected employees' About sections  
* View selected employees' Employment sections 
* View selected employees' Positions sections 
* View selected employees' Address sections 
*  View selected employees' Work contact details sections
*  View selected employees' Lifecycle sections 
*  View the company's people directory

**Manage Employee Data**
* Edit selected employees' Training sections

**Manage Company MetaData**
* Edit all lists (sites, job titles, etc.

**Reports** (needed for **Sync skills**)
* View reports

**Documents** (needed for **Sync certificates**)
* Manage documents

**Job catalog**
* View skills


> Please ensure that you have selected the Lifecycle status of **Employed**, **Hired** and **Terminated**.  This will ensure HiBob sends the correct messaged to SuperPath

> **Note for existing customers:** **View reports**, **Manage documents** and **View skills** were added when skills and certificate sync were released. If you connected HiBob before then, your app was never granted them, so you need to reconnect the integration once before **Sync skills** will work. Go to **Settings → Integrations**, open HiBob, click **Manage**, and click **Reconnect** under **Additional actions**. Accept the requested permissions and tick all three: HiBob refuses the connection outright if the permissions you select do not match the ones the SuperPath app requests, so leaving one out stops the reconnect rather than just that one feature. There is no need to delete the integration, and nothing you have configured is lost. Without **Manage documents** certificates still sync, but the training record's **Doc** column will be empty.


## How To Uninstall and Delete Integration.

To uninstall and delete the integration you will need to perform two actions:

1. Delete the integration from SuperPath.  Go to settings/integrations - click the connected HiBob Integration and click the delete button in the bottom left.  This will remove the integration and access tokens from SuperPath
2. Go to the [HiBob App Marketplace](https://app.hibob.com/marketplace), and uninstall the SuperPath app.

## Troubleshooting and Help

If you have any issues with connecting HiBob or the sync process please reach out to the SuperPath support team using the Chat or email support@superpath.io