Skip to main content

Employment-Hero

Availability
Available CoreAvailable StandardAvailable PlusAvailable ProAvailable Enterprise FlexAvailable PyAirbyte
Support Level
Marketplace
Connector Version
0.0.63 (last updated 11 days ago)
Data workers used
0.2 per sync (Learn more)
Definition ID
e2db518e-ef68-40bb-a2b6-b9f9aabbadb3

This directory contains the manifest-only connector for source-employment-hero.

Documentation reference:​

Visit https://developer.employmenthero.com/api-references/#icon-book-open-introduction for API documentation

Authentication setup​

Employement Hero uses Bearer token authentication, since code granted OAuth is not directly supported right now, Visit your developer profile for getting your OAuth keys. Refer https://secure.employmenthero.com/app/v2/organisations/xxxxx/developer_portal/api for more details.

Getting your bearer token via postman​

You can make a POST request from Postman to exchange your OAuth credentials for an access token to make requests.

First make an app to get the client ID and secret for authentication:

  1. Go to developers portal Page:
  • Visit https://secure.employmenthero.com/app/v2/organisations/xxxxx/developer_portal/api, select Add Application and input an app name. Select the scopes and set the redirect URI as https://oauth.pstmn.io/v1/callback.
  1. Copy Your App Credentials:
  • After creating the app, you will see the Client ID and Client Secret.
  • Client ID: Copy this value as it will be your Client ID in Postman.
  • Client Secret: Copy this value as it will be your Client Secret in Postman.
  1. Visit Postman via web or app and make a new request with following guidelines:
  • Open a new request - Goto Authorization tab - Select OAuth 2.0
  • Auth URL - https://oauth.employmenthero.com/oauth2/authorize
  • Access Token URL - https://oauth.employmenthero.com/oauth2/token
  • Set your client id and secret and leave scope and state as blank

Hit Get new Access token and approve via browser, Postman will collect a new access_token in the console response.

Configuration​

InputTypeDescriptionDefault Value
api_keystringAPI Key.
organization_configidsarrayOrganization ID. Organization ID which could be found as result of organizations stream to be used in other substreams
employees_configidsarrayEmployees ID. Employees IDs in the given organisation found in employees stream for passing to sub-streams

Streams​

Stream NamePrimary KeyPaginationSupports Full SyncSupports Incremental
organisationsidDefaultPaginator✅❌
employeesidDefaultPaginator✅❌
leave_requestsidDefaultPaginator✅❌
employee_certificationsidDefaultPaginator✅❌
pay_detailsidDefaultPaginator✅❌
teamsidDefaultPaginator✅❌
policiesidDefaultPaginator✅❌
certificationsidDefaultPaginator✅❌
custom_fieldsidDefaultPaginator✅❌
employee_custom_fieldsidDefaultPaginator✅❌

IP allow list​

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Reference​

Config fields reference

Field
Type
Property name
API Key
required
string
api_key
array
employees_configids
array
organization_configids

Changelog​

Expand to review
VersionDatePull RequestSubject
0.0.642026-09-2286634Update dependencies
0.0.632026-09-1586035Update dependencies
0.0.622026-09-0885480Update dependencies
0.0.612026-08-1884556Update dependencies
0.0.602026-08-1183920Update dependencies
0.0.592026-08-0483450Update dependencies
0.0.582026-07-2882927Update dependencies
0.0.572026-07-2182420Update dependencies
0.0.562026-07-1481805Update dependencies
0.0.552026-06-3081067Update dependencies
0.0.542026-06-2380448Update dependencies
0.0.532026-06-1679850Update dependencies
0.0.522026-06-0979324Update dependencies
0.0.512026-06-0278697Update dependencies
0.0.502026-04-2877200Update dependencies
0.0.492026-04-2176563Update dependencies
0.0.482026-03-3175776Update dependencies
0.0.472026-03-2475338Update dependencies
0.0.462026-03-1074440Update dependencies
0.0.452026-02-2473901Update dependencies
0.0.442026-02-1773460Update dependencies
0.0.432026-02-1073012Update dependencies
0.0.422026-01-2071917Update dependencies
0.0.412026-01-1471556Update dependencies
0.0.402025-12-1870568Update dependencies
0.0.392025-11-2570162Update dependencies
0.0.382025-11-1869391Update dependencies
0.0.372025-10-2968707Update dependencies
0.0.362025-10-2168566Update dependencies
0.0.352025-10-1467739Update dependencies
0.0.342025-10-0767270Update dependencies
0.0.332025-09-3065842Update dependencies
0.0.322025-08-2365290Update dependencies
0.0.312025-08-0964694Update dependencies
0.0.302025-08-0264327Update dependencies
0.0.292025-07-2664022Update dependencies
0.0.282025-07-1963552Update dependencies
0.0.272025-07-1263015Update dependencies
0.0.262025-07-0562795Update dependencies
0.0.252025-06-2862339Update dependencies
0.0.242025-06-2261989Update dependencies
0.0.232025-06-1461251Update dependencies
0.0.222025-05-2460021Update dependencies
0.0.212025-05-0359446Update dependencies
0.0.202025-04-2658910Update dependencies
0.0.192025-04-1957832Update dependencies
0.0.182025-04-0557283Update dependencies
0.0.172025-03-2956521Update dependencies
0.0.162025-03-2255970Update dependencies
0.0.152025-03-0855320Update dependencies
0.0.142025-03-0154455Update dependencies
0.0.132025-02-1553716Update dependencies
0.0.122025-02-0853322Update dependencies
0.0.112025-02-0152817Update dependencies
0.0.102025-01-2552347Update dependencies
0.0.92025-01-1851681Update dependencies
0.0.82025-01-1151081Update dependencies
0.0.72024-12-2850526Update dependencies
0.0.62024-12-2150024Update dependencies
0.0.52024-12-1449489Update dependencies
0.0.42024-12-1249190Update dependencies
0.0.32024-11-0447819Update dependencies
0.0.22024-10-2847632Update dependencies
0.0.12024-09-2545888Initial release by @btkcodedev via Connector Builder
Was this page helpful?