Skip to main content

HiBob 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 HiBob location.
hibob_api.png

HiBob

Create a HiBob Destination​

  1. Click the + icon on the Nexset that will be sent to the HiBob destination, and select the Send to Destination option from the menu.

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

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

    HiBob destinations can also be configured manually, allowing you to send data to HiBob 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 HiBob endpoints. Each template is designed specifically for the corresponding HiBob 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 Employees from Nexset Records

    Create employees from records in Nexset. Please check API documentation link for all required properties in Nexset record.

    • This endpoint automatically creates new employees in your HiBob account using data from your Nexset. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses POST requests to https://api.hibob.com/v1/people. The endpoint URL is automatically constructed based on the HiBob 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 employee 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 an employee. If you need to create multiple employees, 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 HiBob API after each call.

    The request body must be properly formatted JSON that matches the HiBob API specification for creating employees. 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. The Content-Type: application/json header is automatically included in requests. Please check the API documentation link for all required properties that must be included in your Nexset records. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating employees, including required fields, field names, and request formats, see the HiBob API documentation.

Configure Manually​

HiBob destinations can be manually configured to send data to 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 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 HiBob API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The HiBob API typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the HiBob 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. 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.