For organizations using Employment Hero as their HR system of record, integrating Freshservice via Connector Apps enhances operational efficiency for teams operating at scale. This seamless integration ensures that any Employment Hero updates to employee and user information are instantly accessible within Freshservice. Real-time sync allows the automation of critical employee workflows, such as new hire onboarding processes, offboarding, and more.


This article contains the following topics:


Supported plans

The Employment Hero Connector app is available for customers with active subscriptions to the Pro and Enterprise plans.


Prerequisites for integration

Ensure you have the following, as part of the prerequisites for integration:

  • An active Employment Hero account.

  • The Employment Hero webhook to create jobs is set up. See Registering a webhook for more information.

  • Account administrator privileges within Freshservice to initiate the integration.


Install the app

To install the app:


  1. Go to Admin > Automation & Productivity > Extensibility > Connector Apps.

  2. Select Employment Hero Connector App from the Connector Apps list.

  3. Click Install. The Configuration page opens.

  4. Ensure that your Freshservice API Key is enabled before initiating the installation. Click Next.

Note: The Domain URL and API Key fields are auto-populated.



  1. Enter the relevant Employment Hero connection details in the Client ID, Client secret, and Organization ID fields. Then, click Connect.



  1. (After the connection is established successfully) Click Next on the Connect Employment Hero tab.

  2. Enable the Alerts toggle, if you want to receive email notifications on any errors that are detected within the configured recipes.



  1. Enter the recipient email id(s) in the Email ID field.

  2. Then, click Install.


View dashboard

The Overview page of a connector app includes the Dashboard and Dependency graph tabs.


The Dashboard helps you understand the total number of tasks you've consumed (this is the basis for your app usage billing), and also provides a consolidated graph view of the number of recipes, successful jobs, and failed jobs for all recipes.


To view the dashboard and dependency graph:


  1. Go to Admin > Automation & Productivity > Extensibility > Connector Apps.

  2. Click Employment Hero Connector App. The Configure Employment Hero Connector dialog opens.



  1. Click Got it. The Overview page opens.



Note: Use the Period, Project, All recipes, Service/App, and Tag filters to modify the graph view. You can also sort and view the required data in a tabular format (below the graph), and view your plan usage and connection details on the Dashboard tab.


  1. Go to the Dependency graph tab to view the dependencies in a grid layout.



  1. Click on any icon to view all dependencies, such as Connection, Recipe, API Endpoint, and so on.


Note: Use the Asset, App, and Recipe status filters to modify the grid view.


Set up available recipes

To set up the available recipes:


  1. Go to Admin > Automation & Productivity > Extensibility > Connector Apps.

  2. Click Employment Hero Connector App. The Overview page opens.

  3. Click Recipes. The Recipes page shows you the list of available recipes for the Employment Hero Connector App.



List of all the available default recipes

The following default recipes are available with the Freshservice and Employment Hero Connector integration.


Recipe

Description

Employment Hero Employee Update Sync

This recipe ensures real-time synchronization between Employment Hero and Freshservice by updating employee records in Freshservice whenever changes occur in Employment Hero.

Employment Hero Employee Onboard Sync

Automates employee onboarding in Freshservice by creating necessary user records, assigning assets, and provisioning access based on new hires in Employment Hero.

Employment Hero Employee Offboard Sync

Automates employee offboarding in Freshservice by deactivating user accounts, revoking access, and managing asset retrieval based on employee termination data from Employment Hero.

Employment Hero Employee Historic Sync - Child

Helps you keep Freshservice requester data and Employment Hero employee data in sync.

Employment Hero - Freshservice Historic Sync - Parent

Fetches employee details from Employment Hero at a scheduled time, loops through all employees, and triggers the ‘Employment Hero Employee Historic Sync - Child’ recipe to update Freshservice with historical employee data.


Note: Ensure to start the ‘Employment Hero Employee Historic Sync - Child’ recipe prior to starting this recipe.


Manage available recipes

You can preview, edit, start, test, or stop the available recipes.


Preview recipe

  1. On the Recipes page, click Preview next to the recipe you want to view. The selected recipe’s preview page opens.



The Preview page includes the Recipe, Jobs, Connections, Versions, and Settings tabs.


  1. On the Recipe tab, you can view various steps with pre-configured triggers, actions, and conditions.

  2. Go to the Jobs tab to view all the jobs associated with this recipe.

Note: Use the Repeat job, Cancel job, Search jobs, All statuses, All types, and Period filters to modify or update the Jobs list.


  1. Go to the Connections tab to view all the associated connections.

  2. Go to the Versions tab to view all the associated versions.

Note: Use the Compare versions, Search version comments, All periods, All change types, and All collaborators filters to modify or update the Versions list.


  1. Go to the Settings tab to view the usage metrics, dependencies, and concurrency associated with this recipe.


Start recipe

To start any recipe:


  1. On the Recipes page, click Start next to the recipe you want to start.

  2. Or, click Preview next to the recipe you want to start. Within the recipe preview page, you will find an option to start the recipe.


Edit recipe

To edit any recipe:


  1. Click Preview next to the recipe you want to edit. The selected recipe’s preview page opens. If the recipe is active, click Stop. Then, click Edit.

  2. Or, click the ellipsis icon next to a recipe on the Recipes page. Then, click Edit.



Stop recipe

To stop any recipe:


  1. On the Recipes page, click Stop next to the recipe you want to stop.

  2. Or, click Preview next to the recipe you want to stop. Within the recipe preview page, you will find an option to stop the recipe.


Test recipe

To test any recipe:


  1. On the Recipes page, click Preview next to the recipe you want to test. The selected recipe’s preview page opens. If the recipe is active, click Stop.

  2. Then, select Test recipe from the Start recipe dropdown.



  1. Or, click the ellipsis icon next to a recipe on the Recipes page, and click Edit. The selected recipe page opens.

  2. Click Test recipe.



Customize recipe

Each recipe has the following components: Trigger, Actions, and Conditions. You can customize any recipe depending on your specific requirements.


Let’s take a default recipe as an example to customize it further.


Default recipe: Employment Hero Employee Update Sync


You can click any component, and use the Edit option associated with the component to customize. For example, the Trigger component (as shown in the following figure).



Trigger

This recipe component acts as the starting point for any recipe. For this default recipe, the trigger is fetching an updated employee record from Employment Hero and syncing it with a Freshservice employee record.


You can customize the trigger in the following ways:

  • View the list of optional fields available for a particular trigger.

  • Modify optional fields for existing triggers or add trigger conditions.

  • Add multiple trigger conditions using the ‘+’ option below the trigger conditions section. You can choose to set up AND or OR conditions.

  • Set the trigger data by choosing from a list of available attributes.


Condition

This component acts as a checkpoint within the recipe flow and executes a specific set of actions based on the matched condition.


Here, the recipe checks if an employee record is updated in Employment Hero. Accordingly, an employee record is updated in Freshservice.


You can check and edit the data fields and conditions.


Action

The recipe performs a specific set of actions based on the conditions met. For example, the recipe updates an employee record in Freshservice for an employee record in Employment Hero.


You can customize the following parts of the action:

  • Perform any action from the existing set of available actions.

  • Map values to the corresponding fields in Freshservice.

  • Add more fields from the available set of optional fields.


After customizing a recipe, you can save or test it to ensure it's working correctly.


Check failed recipe or jobs

To view and troubleshoot failed jobs under a recipe, follow these steps:


  1. Click Preview next to a specific recipe on the Recipes page.

  2. Go to Jobs.

  3. View a list of all the jobs executed under a particular recipe.

  4. Filter the failed jobs using the All statuses filter.

  5. Click a failed job to view the error details and identify the cause of failure.

  6. Resubmit the job after your review to fix the issue.


Configure widget settings

After you activate recipes as per your requirement, you can configure widget settings.


  1. Go to Admin > Automation & Productivity > Extensibility > Connector Apps.

  2. Click Employment Hero Connector App. The Overview page opens.

  3. Click Widget Settings. This page shows you a list of fields you can select to display in the Employment Hero widget on any ticket details page across different workspaces.



  1. Enable the Employment Hero widget toggle.

  2. Select the fields you want to display in the Employment Hero widget on the ticket details page.


Note: A sample illustration is shown on the right-side section for your reference.


  1. Click Save.


The widget will now be active and available to use within Freshservice tickets (as shown in the following figure).




Note: For information on frequently asked questions (FAQs) related to the Connector Apps in Freshservice, see Connector Apps: Frequently Asked Questions (FAQs).