diff --git a/connection-guides/hris/employmenthero.mdx b/connection-guides/hris/employmenthero.mdx index d4ba52f6..254a8ca9 100644 --- a/connection-guides/hris/employmenthero.mdx +++ b/connection-guides/hris/employmenthero.mdx @@ -9,87 +9,95 @@ import IntegrationFooter from "/snippets/integration-footer.mdx"; Ensure that your Employment Hero account has Admin privileges. -If you've been directed to StackOne to integrate with Employment Hero, the following steps will help you understand the process and any necessary actions to configure a successful integration. +If you have been directed to StackOne to integrate with Employment Hero, the following steps will help you understand the process and any necessary actions to configure a successful integration. ## Find your Organization ID Your Organization ID is a unique number located in your Employment Hero platform URL. You may need this ID when configuring your integration. - - - Click the **Home** menu and navigate to the **Dashboard** module. - +Look at the page URL in your browser's address bar. You will see a unique number which is your **organization's platform ID**. - - Look at the page URL in your browser's address bar. You will see a unique number which is your **organization's platform ID**. - - For example, if your URL is `https://secure.employmenthero.com/app/organisations/12345/dashboard`, then your organization ID is `12345`. - - +For example, if your URL is `https://secure.employmenthero.com/app/organisations/12345/dashboard`, then your organization ID is `12345`. - - Keep your organization ID handy as you may need it during the integration setup process. - ## Generate Client ID and Secret key - - - - - - - - Navigate to Account > Developer Portal > API - - - - - - On the **API** tab, click the **Add Application** button. - - - Click Add Application - - - - Configure the app with the following details and then click on **Create** button - - **Name**: e.g. StackOne - - **Redirect URL**: `https://api.stackone.com/connect/oauth2/employmenthero/callback` - - **Scopes**: Select the required admin and user scopes to enable data access via API. - - Configure the App Details - - - - Copy your Client ID and Client Secret and store them safely to be used in a later step. - - - Copy your Client ID and Client Secret - - - + + Log in to your Employment Hero account with Admin privileges to access the necessary settings for integration. + + + + Navigate to Account > Developer Portal > API + + + + On the **API** tab, click the **Add Application** button. + + Click Add Application + + + + Configure the app with the following details and then click the **Create** button + - **Name**: e.g. StackOne + - **Redirect URL**: `https://api.stackone.com/connect/oauth2/employmenthero/callback` + - **Scopes**: Select the required admin and user scopes to enable data access via API. Below are the recommended scopes to select: + - `custom_fields:list` + - `employee_custom_fields:list` + - `employees:list` + - `timesheet_entries:list` + - `leave_requests:list` + - `policies:list` + - `rostered_shifts:list` + - `unavailabilities:list` + - `bank_accounts:list` + - `emergency_contacts:list` + - `employment_histories:list` + - `pay_details:list` + - `teams:list` + - `organisations:list` + + Configure the App Details + + Click the **Continue to Review** button to proceed to the next step. + + Review the details and ensure that you have selected the necessary scopes for your integration. + + Configure the App Details + + Click the **Create Application** button to generate your Client ID and Client Secret. + + + Copy your Client ID and Client Secret and store them safely for use in a later step. + + Copy your Client ID and Client Secret + + @@ -97,16 +105,15 @@ Your Organization ID is a unique number located in your Employment Hero platform - Upon reaching the Link Account page, enter the credentials from the previous steps and proceed by clicking the Connect button - - - Enter Credentials - + Upon reaching the Link Account page, enter the credentials from the previous steps, then click the **Connect** button to proceed. + + Enter Credentials + diff --git a/images/employmenthero/image2.png b/images/employmenthero/image2.png index 91565f8b..776805ce 100644 Binary files a/images/employmenthero/image2.png and b/images/employmenthero/image2.png differ diff --git a/images/employmenthero/image6.png b/images/employmenthero/image6.png new file mode 100644 index 00000000..dc4d58fb Binary files /dev/null and b/images/employmenthero/image6.png differ diff --git a/images/employmenthero/image7.png b/images/employmenthero/image7.png new file mode 100644 index 00000000..51f098b5 Binary files /dev/null and b/images/employmenthero/image7.png differ diff --git a/images/employmenthero/image8.png b/images/employmenthero/image8.png new file mode 100644 index 00000000..c6d0f414 Binary files /dev/null and b/images/employmenthero/image8.png differ