Hibob walkthrough

info

Hibob API version 1 is currently supported.

Hibob is a people management platform that simplifies HR tasks and boosts employee engagement. Integrating Hibob with Data Integration streamlines HR processes, providing efficient data management and insightful analytics for better decision-making.

Connection

To connect Hibob API with your destination, follow the step-by-step tutorial. Choose a Source connection after creating a connection.

Predefined reports

Data Integration provides a convenient entry point and recommended approach for accessing a range of predefined reports. Each report includes a concise data description, a list of customizable fields (if applicable), and the schema mapping.

Since these reports follow a standardized format, specific fields are restricted and can only be accessed through Custom reports.

Custom reports

Create custom reports and select a specific report to pull data from the Hibob API v1 after establishing a connection.

People

The People Type report lets you get information about all your employees at once. It has three primary capabilities:

1. Include inactive

Select the checkbox to view inactive personnel in the report.

2. Human readable result

Select this to view human JSON-readable values as opposed to machine-readable data.

3. Extract method

note

Choose All to retrieve all data regardless of time periods.

Select Incremental to have control over your personnel based on their start date field.

note

• Start Date is mandatory.
• Data can be retrieved for the date range specified between the start and end dates.
• If you leave the end date blank, the system pulls the data at the current time of the river's run.
• Date time zone: UTC time.
• Use the Last Days Back For Each Run option to gather data from a specified number of days prior to the selected start date.

When the data you are fetching is large and reaching size or timeout constraints, use the Split your chunks by option to split the data into chunks.

Company reports

You can retrieve a specific report by selecting a Report ID using the company reports type option.

Company lists

You can retrieve all company lists by choosing Company Lists.

Employment history

You can retrieve information about your employees' past events using the Employment History type report. It has two primary capabilities:

1. Include inactive

Select the Include Inactive checkbox to view inactive personnel in the report.

2. Filter by ID You can filter the report for one or more IDs.

Life-cycle history

People can be at different lifecycle stages in your business, ranging from new hires to promotions to departures. Review their current lifecycle status in the system by choosing the life-cycle history report.

It has two primary capabilities:

1. Include inactive

Select the Include Inactive checkbox to view inactive personnel in the report.

2. Filter by ID You can filter the report for one or more IDs.

Out of office

Out Of office returns time off data for a specified date range.

note

• Start Date is mandatory.
• Data can be retrieved for the date range specified between the start and end dates.
• If you leave the end date blank, the data will be pulled at the current time of the river's run.
• Date time zone: UTC time.
• Use the Last Days Back For Each Run option to gather data from a specified number of days prior to the selected start date.
• Use the Future Days Ahead feature to configure automated day-to-day incremental prediction flows for future dates. By removing the limitation of the maximum run date being the current date, users gain increased flexibility in their forecasting capabilities.

List Employee’s Salary History

Lists the salary history entries for the specified employee by entering an ID filter.

List Employee’s Equity Grants

Returns a list of equity grants for a given employee by entering an ID filter.

List Employee’s Work History

This report returns a list of work history entries for the given employee using the ID filter.