Skip to main content

Hive HR

Hive HR is an innovative employee feedback platform designed to help businesses engage with their workforce and improve employee experience through continuous feedback collection, performance insights, and employee engagement tools that foster a positive workplace culture.

Hive HR icon

Power end-to-end data operations for your Hive HR API with Nexla. Our bi-directional Hive HR connector is purpose-built for Hive HR, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Hive HR or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Hive HR workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Hive HR credential, you need to obtain an API Key from your Hive HR account. The API Key is required to authenticate with the Hive HR API.

To obtain your API Key, follow these steps:

  1. Sign in to your Hive HR account using your administrator credentials.

  2. Navigate to your account settings or administrator panel. The exact location may vary depending on your Hive HR account configuration.

  3. Locate the API Settings or API Keys section in your account settings.

  4. Generate a new API Key or use an existing one. If you're generating a new API Key, you may be asked to provide a name or description for the key to help identify it later.

  5. Copy the API Key immediately after generation, as it may not be displayed again for security reasons. Store the API Key securely, as you will need it to configure your Nexla credential.

The API Key is sent in the Authorization header with the Bearer prefix (e.g., Authorization: Bearer {api_key}) for all API requests to the Hive HR API. The API Key authenticates your account and grants access to your Hive HR data, including employee information, time tracking, and other HR-related data. For detailed information about API key setup, authentication, and available API endpoints, refer to the Hive HR API documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
API Key ValueYesYes

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Hive HR

HiveHRCred.png
  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  2. Enter your Hive HR API Key in the API Key Value field. This is the API Key you obtained from your Hive HR account settings in Prerequisites. Hive HR uses API Key authentication for all API requests; the API Key is sent in the Authorization header with the Bearer prefix (e.g., Authorization: Bearer {api_key}) and authenticates your account, determining what data and operations you can access based on your account permissions.

    Keep your API Key secure and do not share it publicly. The API Key provides access to your Hive HR account data and should be treated as sensitive information. If your API Key is compromised, you should immediately regenerate it in your Hive HR account settings. You can view and manage API keys in your Hive HR account settings. The API Key is sent in the Authorization: Bearer {api_key} header for all API requests to the Hive HR API. The API Key does not expire automatically, but you can regenerate it at any time if needed. For detailed information about obtaining and managing API keys, API authentication, and available endpoints, see the Hive HR API documentation.

  3. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Hive HR connector tile, 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.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Hive HR endpoints. 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.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Hive HR data sources can also be manually configured to ingest data from any valid Hive HR API endpoint, including endpoints not covered by the pre-built templates or when custom API configurations are needed. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Hive HR API endpoints typically follow the pattern https://api.hive.hr/v1/{endpoint_path} and return data in JSON format. Requests are authenticated automatically via the Authorization: Bearer {api_key} header configured in your credential; some endpoints may require additional headers such as organizationid for organization-specific requests. For detailed information about available endpoints, see the Hive HR API documentation.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Hive HR data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Hive HR destination, and select the Send to Destination option from the menu. Select the Hive HR connector from the list of available destination connectors, then select the credential that will be used to connect to the Hive HR organization, and click Next; or, create a new Hive HR credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Hive HR endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create user

Create user

  • This endpoint automatically creates a new user in your Hive HR organization using data from your Nexset. No additional configuration is required beyond selecting this endpoint template.
  • The endpoint uses POST requests to https://api.hive.hr/v1/user/users. The endpoint URL is automatically constructed based on the Hive HR API base URL.
  • The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically formatted according to the schema fields and data mapping you configure. Each record in your Nexset will be sent as a JSON object containing the user data to create.
  • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a user. If you need to create multiple users, you can send multiple records, but each will be processed as a separate request.
  • This endpoint does not automatically create a data source to track the responses received from the Hive HR API after each call.

The request body must be properly formatted JSON that matches the Hive HR API specification for creating users. The endpoint requires API Key authentication via the Authorization: Bearer {api_key} header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating users, including required fields, field names, and request formats, see the Hive HR API documentation.

Update user

Update user

  • Enter the user ID in the User id field. This is the unique identifier for the user you want to update in your Hive HR organization.
  • The endpoint uses PUT requests to https://api.hive.hr/v1/user/users/{user_id} where {user_id} is the User id you provide. The endpoint URL is automatically constructed based on the Hive HR API base URL and the user ID.
  • The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically formatted according to the schema fields and data mapping you configure. Each record in your Nexset will be sent as a JSON object containing the user data to update.
  • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to update a user. If you need to update multiple users, you can send multiple records, but each will be processed as a separate request.
  • This endpoint does not automatically create a data source to track the responses received from the Hive HR API after each call.

The request body must be properly formatted JSON that matches the Hive HR API specification for updating users. The endpoint requires API Key authentication via the Authorization: Bearer {api_key} header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. You must provide the user ID to update an existing user. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about updating users, including required fields, field names, and request formats, see the Hive HR API documentation.

Manual configuration

Hive HR destinations can also be manually configured to send data to any valid Hive HR API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Hive HR API endpoints typically follow the pattern https://api.hive.hr/v1/{endpoint_path} and generally use JSON format for request bodies. Requests are authenticated automatically via the Authorization: Bearer {api_key} header configured in your credential; some endpoints may require additional headers such as organizationid for organization-specific requests. For detailed information about available endpoints, see the Hive HR API documentation.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Hive HR endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Hive HR endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.