Skip to main content

Hive HR Destination

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 sends data to a Hive HR location.
hive_hr.png

Hive HR

Create a Hive HR Destination​

  1. 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.

  2. 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.

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

    Hive HR destinations can also be configured manually, allowing you to send data to Hive HR endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Hive HR endpoints. Each template is designed specifically for the corresponding Hive HR endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, 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.

Configure Manually​

Hive HR destinations can be manually configured to send data to 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 destinations, such as destinations that use custom request headers, different HTTP methods, or custom data formatting.

Content Format​

  1. Select the format in which the Nexset data will be sent to the Hive HR API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Hive HR API typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the Hive HR API endpoint to which you want to send the Nexset data in the 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.