Skip to main content

HiBob Data Source

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that ingests data from a HiBob location.
hibob_api.png

HiBob

Follow the instructions below to create a new data flow that ingests data from a HiBob source in Nexla.

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the HiBob connector tile from the list of available connectors. Then, select the credential that will be used to connect to the HiBob account, and click Next; or, create a new HiBob credential for use in this flow.

  3. In Nexla, HiBob data sources can be created using pre-built endpoint templates, which expedite source setup for common HiBob endpoints. Each template is designed specifically for the corresponding HiBob endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    HiBob sources can also be configured manually, allowing you to ingest data from HiBob endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common HiBob endpoints. Each template is designed specifically for the corresponding HiBob endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Fetch all Employees

    Fetch a list of all active employees. The data is filtered based on the access level of the logged-in user. Only viewable categories are returned.

    • This endpoint automatically retrieves all active employees from your HiBob account. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to https://api.hibob.com/v1/people. The endpoint URL is automatically constructed based on the HiBob API base URL.
    • The endpoint does not use pagination (iteration.type: static.url) and returns a single response. The response data path is $.employees[*], which extracts all items from the employees array in the API response.
    • The data returned is filtered based on the access level of the Service User used for authentication. Only viewable categories are returned, ensuring that sensitive information is not exposed based on the Service User's permissions.

    This endpoint retrieves all active employees from your HiBob account. The data is filtered based on the access level of the Service User used for authentication, so only viewable categories are returned. This ensures that sensitive information is not exposed based on the Service User's permissions. The endpoint returns employee information including personal details, employment information, and other relevant data based on the Service User's access level. For detailed information about the API response format and available fields, see the HiBob API documentation.

    Fetch Work History of All Employees

    Returns a list of work history entries for all active employees.

    • This endpoint automatically retrieves work history entries for all active employees from your HiBob account using a multi-step process. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint first retrieves all active employees using GET requests to https://api.hibob.com/v1/people. The response data path is $.employees[*], which extracts all items from the employees array.
    • For each employee retrieved in the first step, the endpoint then retrieves their work history using GET requests to https://api.hibob.com/v1/people/{employee_id}/work where {employee_id} is the ID of each employee from the first step. The response data path is $.values[*], which extracts all items from the values array in the API response.
    • The endpoint processes all employees and their work history entries, creating a comprehensive dataset of work history information for all active employees.

    This endpoint retrieves work history entries for all active employees from your HiBob account. The endpoint uses a multi-step process: first retrieving all active employees, then fetching work history for each employee. This ensures that you get a complete view of work history across all employees. The data is filtered based on the access level of the Service User used for authentication, so only viewable information is returned. For detailed information about the API response format and available fields, see the HiBob API documentation.

Configure Manually​

HiBob data sources can be manually configured to ingest data from any valid HiBob API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex HiBob sources, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Content Format​

  1. Select the format in which the data from the HiBob API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The HiBob API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the HiBob API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. HiBob API endpoints typically follow the pattern https://api.hibob.com/v1/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires Basic authentication via the Authorization header, where the Service User ID is sent as the username and the Service User Token is sent as the password, which is handled automatically by your credential configuration. For detailed information about HiBob API endpoints and available APIs, see the HiBob API documentation.