> ## Documentation Index
> Fetch the complete documentation index at: https://university.triggr-app.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Employment Hero

> Connect Employment Hero to Triggr with an OAuth application from the Employment Hero Developer Portal.

Triggr reads Employment Hero organisations, employees, teams and leave, as the user who authorises it. Your plan must include API access and the Developer Portal, such as Platinum HR, eOS Plus or eOS Unlimited; see [Accessing the Employment Hero API and Developer Portal](https://help.employmenthero.com/hc/en-au/articles/17426641029007-Accessing-the-Employment-Hero-API-and-Developer-Portal).

## Set up Employment Hero

<Steps>
  <Step title="Add an application">
    In [Employment Hero](https://secure.employmenthero.com), click your profile name, select **Developer Portal** and click Add Application. Set the redirect URI to exactly `https://app.triggr-app.com/oauth/callback`.
  </Step>

  <Step title="Choose the scopes">
    Select the read scope for each area your workflows use: organisations, employing entities, work locations, cost centres, employees, employment history, custom fields, certifications, emergency contacts, teams and leave. Always include organisations (`urn:mainapp:organisations:read`), as other actions need an organisation ID.

    <Warning>You can't change scopes after creating the application. To add one later, register a new application and replace the credentials in Triggr.</Warning>
  </Step>

  <Step title="Copy the credentials">
    Create the application and copy the Client ID and Client Secret.
  </Step>
</Steps>

See Employment Hero's [Obtain Credentials](https://developer.employmenthero.com/api-references#obtain-credentials) guide.

## Connect it in Triggr

<Steps>
  <Step title="Open the integration">
    Go to **Integrations > Employment Hero** and click **Configure** on the Base Configuration card.

    <Frame>
      <img src="https://mintcdn.com/triggr/nyuVXZ1rouDTTEvu/images/integrations-common/base-configuration.png?fit=max&auto=format&n=nyuVXZ1rouDTTEvu&q=85&s=bb81acb082055015f91beda7b4876f35" alt="The Base Configuration card with Status Not Configured, Admin Consent Not Required and a Configure button." width="2272" height="330" data-path="images/integrations-common/base-configuration.png" />
    </Frame>
  </Step>

  <Step title="Enter the credentials">
    Enter the Client ID and Client Secret, then click **Save Configuration**.

    <Frame>
      <img src="https://mintcdn.com/triggr/nyuVXZ1rouDTTEvu/images/employment-hero/configure.png?fit=max&auto=format&n=nyuVXZ1rouDTTEvu&q=85&s=11f1e7601bceeb0808b0572838ca91d8" alt="The Employment Hero configuration window with Client ID and Client Secret fields, an Allow insecure TLS switch under Advanced, and a Save Configuration button." width="1344" height="1158" data-path="images/employment-hero/configure.png" />
    </Frame>
  </Step>

  <Step title="Authorize">
    Click **Authorize** on the Base Configuration card and sign in as an Employment Hero user, such as an admin, who can see the organisations and employees your workflows need. Click Authorize again whenever you change the credentials.
  </Step>
</Steps>

In workflows, run List Organisations first to get the `organisation_id` most actions need.

## Troubleshooting

<AccordionGroup>
  <Accordion title="Developer Portal isn't in the profile menu">
    Your plan doesn't include API access. Check it against Employment Hero's [supported plans](https://help.employmenthero.com/hc/en-au/articles/17426641029007-Accessing-the-Employment-Hero-API-and-Developer-Portal).
  </Accordion>

  <Accordion title="Employment Hero shows an error instead of the sign-in page">
    Check the application's redirect URI is exactly `https://app.triggr-app.com/oauth/callback` with no trailing slash, and that the Client ID in Triggr belongs to it.
  </Accordion>

  <Accordion title="Steps fail with 401">
    Re-enter the Client ID and Client Secret with no spaces, click Save Configuration, then Authorize again.
  </Accordion>

  <Accordion title="Steps fail with 403, or an organisation is missing">
    The authorising user can't see that data, or the application lacks its read scope. Authorize as a user who can, or register a new application with the scope.
  </Accordion>

  <Accordion title="Rate limited (429)">
    Employment Hero allows 20 requests per second and 100 per minute. Spread large workflows out, or fetch up to 100 items per page.
  </Accordion>
</AccordionGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.