Hibob

Version 0.0.16

πŸ“˜

Checkout theΒ docs here for more information

Set up


To set up the Hibob connector, you will need an API token. The token can be obtained from the the API access section of your profile in the Hibob front-end. Please see the API docs link above ☝️ for further guidance. Please also ensure you have given the API token sufficient 'Approved Scopes'. Here are for instructions on managing these scopes.

Features


FeatureSupportNotes
Backfillβœ…All-time except for Time-Off which is customisable by selecting a date
Incremental❌
API reliability🟒Reliable

Accessing 'People' Report Data

To access your specific employee/people data, we require the Employee Fields Report from your Hibob account. To ensure that all your fields are included, please contact your Kleene representative; we can provide a guide on how to obtain this report.
This applies to reports which require 'Input Fields', which are: 'People (All Fields)', 'People List Fields', 'People Non-List Fields' and 'List Field Information'.

Reports detail


⬇️ ReportπŸ”‘ Incremental keyπŸ”‘ Primary keyπŸ“„ Link to API endpoint
People (All Fields)N/AidSearch for employees
People List FieldsN/AidSearch for employees
People Non-List FieldsN/AidSearch for employees
TasksN/AidRead all open tasks
ReportsN/AidRead company reports
Download ReportN/AidDownload the report by id
Time OffN/Arequest_idGet timeoff since the specified date
SalariesN/AidList employees salary history
LifecyclesN/AidList employee's life-cycle status history
Work HistoryN/AidList employee's work history
Employment HistoryN/AidList employee's work history
Named ListsN/AnameGet all company named lists
List Field InformationN/AnameGet a specific company list by name
FieldsN/AidGet all company fields
PayrollN/AidRead payroll history
TitlesN/AidGet specific company named list
TrainingN/AidGet employee's training records
All Custom TablesN/Aemployee_id ,table_idRead all entries of the given custom table
Single Custom TableN/Aemployee_idRead all entries of the given custom table
Custom Tables MetadataN/AidRead metadata of custom tables defined

List Fields Information

For general use, the 'People (All Fields)' report allows you to access your employee information comprehensively. The reports 'People List Fields' and 'People Non-List Fields' are provided separately because 'List' fields are processed differently than non-list fields in the Hibob API. These separate reports help identify which fields fall into each category.

The 'List Field Information' is there for clarity, as a 'List' field can be a custom field and may have a complex name, such as "custom.category_1667869.field_145656867". When you run this report, it will translate the custom field names into more understandable values. For example, "category_1667869.field_145656867" might represent the location where employees work, and the report will display the locations as values.

πŸ“˜

Values in "All Custom Tables" and "Single Custom Table" reports

The data in the "VALUES_" field will be of key value pairs, where the keys are in fact not the names of the columns of the custom table, but the id-s of those columns.

You may want to deal with that in a Transofrm layer. The Custom Tables Metadata report will contain the information which column id corresponds to which column name.

πŸ“˜

Single Custom Table

This report will need you to specify a Custom Table name.

It is important to give the correct name exactly as it appears on the custom table. The field is also case-sensitive.