Skip to main content

HoorayHR Data Source

The HoorayHR connector enables you to ingest HR data—including employee records, leave requests, leave type configurations, and absence records—from your HoorayHR account into Nexla. Follow the instructions below to create a new data flow that ingests data from a HoorayHR source in Nexla.
hooray_hr_api.png

HoorayHR

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

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

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

    Users

    This endpoint retrieves all employee (user) records from your HoorayHR account. Use this endpoint when you need to access employee profile data for reporting, analytics, or synchronization with other systems. The response includes personal information, contact details, employment dates, job titles, and organizational assignments for each employee.

    • This endpoint automatically retrieves all employees accessible to the authenticated account. No additional parameters are required beyond selecting this template—Nexla will fetch all records from the HoorayHR /users endpoint using GET requests.
    • The HoorayHR Users endpoint returns comprehensive employee records. Common fields include employee ID, name, email address, employment start date, job title, department, and manager assignment. Use Nexla's schema and transformation tools to map these fields to your target system's requirements.

    The data accessible through this endpoint is determined by the permissions of the HoorayHR account used in the credential. Ensure the account has HR manager or administrator access to retrieve records for all employees in your organization.

    Time Off

    This endpoint retrieves all leave request records from your HoorayHR account. Use this endpoint to access time-off data for HR reporting, payroll processing, workforce planning, or compliance auditing. Each record includes the employee, leave dates, leave type, approval status, approver details, and budget impact information.

    • This endpoint automatically retrieves all time-off records accessible to the authenticated account. No additional parameters are required—Nexla fetches all leave requests from the HoorayHR /time-off endpoint using GET requests.

    • Time-off records in HoorayHR capture the full lifecycle of each leave request, including:

      • The requesting employee and submission date
      • Start and end dates of the leave period
      • Leave type (linked to the leave type configuration)
      • Approval status and approver identity
      • Budget tracking information showing days deducted from leave balances

    To enrich time-off records with leave type details such as category name and accrual rules, combine this endpoint with the Leave Types endpoint in a multi-source Nexla flow.

    Leave Types

    This endpoint retrieves the leave type configuration records defined in your HoorayHR account. Use this endpoint when you need to understand the categories of leave available to employees, their accrual rules, budget allocations, and calculation methods. This data is useful for building HR analytics dashboards or synchronizing leave policies with external payroll or scheduling systems.

    • This endpoint automatically retrieves all leave type configurations from the HoorayHR /leave-types endpoint. No additional parameters are required.

    • Leave type records include configuration details such as:

      • Leave type name and identifier
      • Budget allocation rules (e.g., annual entitlement in days)
      • Accrual calculation method (calendar year, employment anniversary, etc.)
      • Whether the leave type is paid or unpaid
      • Any carry-over or expiration policies defined in HoorayHR

    Leave type configurations in HoorayHR are managed by HR administrators. Changes to leave type rules in HoorayHR are reflected in subsequent API responses. Re-run this data source after policy changes to keep your downstream systems up to date.

    Sick Leaves

    This endpoint retrieves absence (sick leave) records from your HoorayHR account. Use this endpoint when you need to access employee absenteeism data for HR reporting, occupational health tracking, payroll processing, or compliance with labor regulations. Records include reported and actual absence dates, return-to-work information, and approval details.

    • This endpoint automatically retrieves all sick-leave records accessible to the authenticated account from the HoorayHR /sick-leave endpoint. No additional parameters are required.

    • Sick-leave records in HoorayHR capture both the employee-reported absence and any administrative updates, including:

      • The employee and the date the absence was reported
      • The reported start date and the actual start date of the absence (which may differ)
      • The return-to-work date once the employee is back
      • Approval status and responsible HR contact
      • Any notes or follow-up actions recorded in HoorayHR

    Sick-leave data may be subject to privacy and data protection regulations (such as GDPR) in your jurisdiction. Ensure that your Nexla flows handle this sensitive data in compliance with your organization's data governance policies and applicable law.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

HoorayHR data sources can be manually configured to ingest data from any valid HoorayHR 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 HoorayHR sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request headers or parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the HoorayHR API from the Method pulldown menu. HoorayHR's data retrieval endpoints use:

    • GET: For retrieving employee, leave, and absence records from the API — this is the method used by all standard HoorayHR read endpoints.
    • POST: For creating or submitting data to the API (if writing back to HoorayHR).

API Endpoint URL​

  1. Enter the URL of the HoorayHR API endpoint from which this source will fetch data in the Set API URL field. HoorayHR's REST API base URL is https://api.hooray.nl. Common endpoint paths include:

    • /users — Employee records
    • /time-off — Leave requests
    • /leave-types — Leave type configurations
    • /sick-leave — Absence records

    Enter the complete URL including the base URL and path, for example: https://api.hooray.nl/users.

The complete HoorayHR API reference, including all available endpoints, request parameters, and response schemas, is available in the HoorayHR API documentation.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Date/time macros are particularly useful when querying HoorayHR endpoints that accept date filters as query parameters, such as filtering leave or absence records by date range.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that adapt based on existing data.

Lookup-based macros are useful when, for example, you need to pass a specific employee ID or leave type ID as a path parameter when querying a HoorayHR endpoint that returns data for a single resource.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by the API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when HoorayHR API responses contain wrapper objects, metadata, or pagination information that you do not need in your dataset.

For example, the HoorayHR API may return a JSON object with a top-level array of employee records. By entering the path to that array, you configure Nexla to treat each element in the array as an individual record.

Path to Data is essential when HoorayHR API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format, enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.data.items[*] to access an array of items within a data object).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

    Path to Data Example:

    If the HoorayHR API response is in JSON format and returns records in a top-level array, the path to the data would be entered as $[*]. If records are nested under a key named data, the path would be $.data[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

Metadata paths are particularly useful for preserving API response context like request IDs, timestamps, or summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers may be required for API versioning or content type specifications.

    You do not need to include the Authorization header. Nexla injects the Bearer token obtained from the HoorayHR authentication endpoint automatically based on the credential configuration.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new HoorayHR 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.