Skip to main content

Employment Hero Data Source

The Employment Hero connector enables you to ingest HR and workforce data — including employee records, leave requests, certifications, and timesheets — directly into Nexla data flows. Follow the instructions below to create a new data flow that ingests data from an Employment Hero source in Nexla.
employment_hero_api.png

Employment Hero

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

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

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

    List Organisations

    Retrieves all organisations accessible to the authenticated integration. Use this endpoint to obtain the organisation IDs needed for other Employment Hero endpoints, or to ingest top-level organisation metadata such as name, country, phone number, logo, and primary address.

    • This endpoint does not require any additional configuration parameters. Select it from the Endpoint menu and proceed to testing.
    • Results are returned as a paginated list. Nexla automatically iterates through all pages to retrieve the complete dataset.

    Organisation IDs returned by this endpoint are required as input for the List Employees, List Leave Requests, List Certifications, and List Timesheet Entries endpoints. Run this endpoint first to discover the Organisation IDs available to your integration.

    List Employees

    Retrieves all employees for a specified organisation. Employee records include personal details, employment status, job title, department, start date, and other profile information. Use this endpoint to build workforce rosters, sync employee data to analytics systems, or maintain up-to-date people records.

    • Enter the unique identifier of the organisation whose employees you want to retrieve in the Organisation ID field. You can obtain the Organisation ID using the List Organisations endpoint.
    • Results are paginated and Nexla will automatically retrieve all pages of employee records.

    The Organisation ID is a required field. Ensure you have obtained a valid Organisation ID from the List Organisations endpoint before configuring this template. Your OAuth 2.0 application scopes must include urn:mainapp:employees:read to access employee data.

    List Leave Requests

    Retrieves all leave requests for a specified organisation. Each record includes the leave type, start and end dates, total hours, approval status, and the requesting employee. Use this endpoint to track leave trends, monitor absence patterns, or sync leave data into workforce planning or analytics tools.

    • Enter the unique identifier of the organisation whose leave requests you want to retrieve in the Organisation ID field.
    • Results are paginated and Nexla will automatically retrieve all pages.

    Leave request data includes both pending and approved requests. Filter by status within Nexla transforms if you need only approved leave records for downstream analysis.

    List Certifications

    Retrieves all certifications defined for a specified organisation. Certification records include the certification name, type, expiry date, and status. Use this endpoint to monitor compliance requirements, track employee credential expiry dates, or report on workforce qualifications.

    • Enter the unique identifier of the organisation whose certifications you want to retrieve in the Organisation ID field.
    • Results are paginated and Nexla will automatically retrieve all pages.

    Certification data can be combined with employee data to identify employees whose certifications are approaching expiry, enabling proactive compliance management.

    List Timesheet Entries

    Retrieves all timesheet entries for a specified employee within an organisation. Each record includes clock-in and clock-out times, total hours worked, the associated date, and any associated break times. Use this endpoint to integrate timesheet data into payroll systems, analyse workforce productivity, or audit time-tracking accuracy.

    • Enter the unique identifier of the organisation in the Organisation ID field.
    • Enter the unique identifier of the employee whose timesheet entries you want to retrieve in the Employee ID field. Employee IDs can be obtained from the List Employees endpoint.
    • Results are paginated and Nexla will automatically retrieve all pages.

    Both Organisation ID and Employee ID are required fields for this endpoint. To retrieve timesheet entries across all employees in an organisation, use chained data flows — first ingest employees with the List Employees endpoint, then use the resulting Employee IDs as inputs to this endpoint.

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​

Employment Hero data sources can be manually configured to ingest data from any valid Employment Hero 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 Employment Hero sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request 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 Employment Hero API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the Employment Hero API endpoint from which this source will fetch data in the Set API URL field. The base URL for all Employment Hero API v1 endpoints is https://api.employmenthero.com/api/v1/. Append the specific resource path to this base URL — for example, https://api.employmenthero.com/api/v1/organisations to list all organisations, or https://api.employmenthero.com/api/v1/organisations/{organisation_id}/employees to list employees for a specific organisation.

Replace path parameters such as {organisation_id} and {employee_id} with the actual ID values before entering the URL. Ensure the endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

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.

Macros are particularly useful for Employment Hero endpoints that accept date filters, such as filtering leave requests or timesheet entries by date range. Using macros enables incremental data ingestion rather than fetching the entire dataset on each run.

  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 can adapt based on existing data.

Lookup-based macros are useful when you need to construct Employment Hero API endpoint URLs that reference specific Organisation IDs or Employee IDs sourced from another Nexla data flow.

  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 that will be 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. Employment Hero API responses typically return a JSON object with a data array containing the records of interest, plus pagination metadata.

For example, when retrieving a list of employees, the API returns a JSON object where the employee records are in the data array. By entering the path $.data[*], you configure Nexla to treat each element of the data array as a separate record.

Path to Data is essential when Employment Hero 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:

    For most Employment Hero API v1 endpoints, the response contains a top-level data array with the resource records. Enter $.data[*] to configure Nexla to treat each element of the array as a record.

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. Employment Hero API responses include pagination metadata (such as total record count and current page) alongside the data array. If this information is useful for your downstream analysis, you can configure Nexla to attach it to each record.

Metadata paths are particularly useful for preserving API response context like total record counts or pagination information that applies 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). The Employment Hero API accepts standard HTTP headers such as Accept:application/json for JSON responses.

    You do not need to include any headers already present in the credentials. The OAuth 2.0 Authorization header is automatically handled by Nexla based on your 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 Employment Hero 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.