HiBob | Token and User ID Authentication

In this article, we help you locate your HiBob Token and User ID so you can finish integrating HiBob with Oyster. HiBob requires you to create an API Service User in order to configure your HiBob integration, this is needed so you do not have to use your personal HiBob account to connect and will allow you a granular control of what data you want to make available specifically for Reachdesk integration.

Prerequisites

  • You have completed Steps 1-6 of Connecting HiBob to Oyster
    • You selected to authenticate via HiBob Token and User ID
  • You have Admin access to your company’s HiBob account.
  • You are logged in to HiBob with your admin credentials.

Create the Service User ID and Token

  1. Click Settings.
  2. Select Integrations.
  3. Click Manage under Service Users.

hibob-user-id_manage.png

  1. Click the +New Service User button.

hibob-user-id_new.png

  1. Type a Service User Name.
  2. Type a Display Name
  3. Click Next. The Service User ID and Token display.
  4. Save the Service User ID and Token!

    ‼️ You will need this in a later step. If you misplace this information you'll have to repeat the above process.

hibob-user-id_name.png

Create a Permission Group

A Permission Group enables you to specify which service users (and Oyster) have access to HiBob. 

  1. Click Settings > Permission groups and click the Create group button. The Create group page appears.

  1. Provide a Group name.
    • For example: Oyster Service User Group
  2. In the Group members section, select the Select people by condition option and click Edit.

  1. In the Select people by condition page, delete the existing condition.
  2. Click the Add Specific Employees drop-down and select the Service User you just created.
  3. Click Apply.
  4. Finish the initial creation of the Group by clicking Create.
    • If a pop-up appears, Confirm the creation of the group.

  1. In the People's Data section, select the Select people by condition option and click Edit.
  2. Select the following from the drop-downs: 
    • Lifecycle Status
    • Equals
    • Employed, Hired, Terminated and click Apply
  3. Click Apply in the Select by condition window.
  4. Click Save

Configure Permissions for the permissions group

These permissions enables you to specify which data in HiBob the service users (and Oyster) have access to. 

  1. In the People's Data section, add the following permissions for People and Time Off:
hibob-user-id_peoplesdata.png

Time Off

  • Balance

    • See selected people's time off and sick leave balances

  • Requests

    • 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

    • View, approve, or decline requests that are pending approval of others

  • See who's out today

    • See who's out today

People

  • Address

    • View selected employees' Address sections

    • View selected employees' Address section histories

  • EEO

    • View selected employees' EEO sections

  • Email

    • Edit selected employees' email addresses

  • Employment

    • View selected employees' Employment sections

    • View selected employees' Employment section histories

  • History

    • View selected employees' profile changes history

  • Home

    • View selected employees' Home sections

  • Identification

    • View selected employees' Identification sections

    • Edit selected employees' Identification sections (only applicable if you want fully visible SSN numbers.)

  • Lifecycle

    • View selected employees' Lifecycle sections (This is needed to surface Employment Status)

    • Edit selected employees' Lifecycle sections

    • View selected employees' Lifecycle section histories

  • Payroll

    • View selected employees' Payroll sections

    • View selected employees' Payroll section histories

  • Personal

    • View selected employees' Personal sections

    • Edit selected employee's Personal sections (This is needed to surface Date of Birth)

  • Personal Contact Details

    • View selected employees' Personal contact details sections

    • Edit selected employees' Personal contact details sections

  • Work

    • View selected employees' Work section histories

  1. Click Save and Apply the changes.
  1. Return to the HiBob integration in your Oyster account.
  2. Add the User ID and Token you created and saved.
  3. Click Submit.

HiBob is now integrated with Oyster and appears on the My integrations tab.

hibob-user-id_submit.png

Was this article helpful?

0 out of 0 found this helpful