Skip to main content

Hive HR 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 Hive HR location.
hive_hr.png

Hive HR

Follow the instructions below to create a new data flow that ingests data from a Hive HR 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 Hive HR connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Hive HR account, and click Next; or, create a new Hive HR credential for use in this flow.

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

    Hive HR sources can also be configured manually, allowing you to ingest data from Hive HR 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 Hive HR endpoints. Each template is designed specifically for the corresponding Hive HR 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.

    Search users

    Search for users

    • Enter the organization ID in the Organization id field. This is the unique identifier for your Hive HR organization. The organization ID is required to search for users within your organization.
    • The endpoint uses POST requests to https://api.hive.hr/v1/user/users/ids/search. The endpoint URL is automatically constructed based on the Hive HR API base URL.
    • The endpoint includes the organization ID in the request header as organizationid: {organization_id} where {organization_id} is the Organization id you provide. The request header is automatically constructed based on the organization ID you provide.
    • The endpoint does not use pagination (iteration.type: static.url) and returns a single response. The response data path is $.data[*], which extracts all items from the data array in the API response.

    This endpoint searches for users in your Hive HR organization. The endpoint uses a POST request with the organization ID in the request header to search for users. The endpoint returns user information including user IDs and other user details. The endpoint does not use pagination and returns a single response with the search results. For detailed information about the API request format, response format, and available fields, see the Hive HR API documentation.

Configure Manually​

Hive HR data sources can be manually configured to ingest data from any valid Hive HR 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 Hive HR 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 Hive HR API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The Hive HR API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the Hive HR 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. Hive HR API endpoints typically follow the pattern https://api.hive.hr/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 API Key authentication via the Authorization: Bearer {api_key} header, which is handled automatically by your credential configuration. Some endpoints may require additional headers such as organizationid for organization-specific requests. For detailed information about Hive HR API endpoints and available APIs, see the Hive HR API documentation.