Skip to main content

Employment Hero Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to an Employment Hero location.
employment_hero_api.png

Employment Hero

Create an Employment Hero Destination​

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

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

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

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

    List Employees

    Sends employee record data to an Employment Hero organisation endpoint. Use this template to create or update employee records in Employment Hero from an external source, enabling automated onboarding workflows or employee data synchronisation.

    • Enter the unique identifier of the target Employment Hero organisation in the Organisation ID field. This determines which organisation the employee records will be written to.
    • Ensure the Nexset data fields are mapped to the correct Employment Hero employee fields before activating the destination. Use Nexla's field mapping and transformation tools as needed.

    Your OAuth 2.0 application scopes must include write permissions for employee data. Verify that the appropriate scopes are configured in the Employment Hero Developer Portal before attempting to write data. Refer to the Employment Hero API documentation for the complete list of writable employee fields and required formats.

    List Leave Requests

    Sends leave request data to an Employment Hero organisation endpoint. Use this template to submit or update leave requests in Employment Hero from an external scheduling or HR system.

    • Enter the unique identifier of the target Employment Hero organisation in the Organisation ID field.
    • Ensure that the leave request fields in your Nexset — including leave type, start date, end date, employee ID, and status — are correctly mapped to Employment Hero's expected request format.

    Leave request submissions require valid employee IDs. Ensure employee IDs in your Nexset match those in Employment Hero before activating the destination.

Configure Manually​

Employment Hero destinations can be manually configured to send data to any valid Employment Hero API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Employment Hero API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, 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. For creating new records use POST; for updating existing records use PUT or PATCH.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Employment Hero API from the Content Format pulldown menu. The Employment Hero API accepts JSON-encoded request bodies. Select JSON to ensure Nexla automatically converts your Nexset data to the correct format for each API call.

API Endpoint URL​

  1. Enter the URL of the Employment Hero API endpoint to which you want to send the Nexset data in the URL field. The base URL for all Employment Hero API v1 endpoints is https://api.employmenthero.com/api/v1/. Append the specific resource path — for example, https://api.employmenthero.com/api/v1/organisations/{organisation_id}/employees to write employee records to a specific organisation. For update/upsert operations, include the ID of the object to be updated at the end of the URL.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). The Employment Hero API expects Content-Type:application/json for write operations.

    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.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Employment Hero destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the Employment Hero API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Employment Hero API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Employment Hero API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Employment Hero API using the current settings.

Save & Activate the Destination​

  • 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 Employment Hero endpoint, open the destination resource menu, and select Activate.

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