Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Currently, the native integration is composed by three main parts:

Entity

Description

Direction

Employee

Creating, updating or deleting* an employee in Employment Hero automatically does the same in Tātou

* Deleting makes the employee inactive in Tātou

Employment Hero → Tātou

PayPeriod

Timesheet entries for a period

Tātou → Employment Hero

PayEarning

When the Pay Run is finished in Employment Hero, it sends the awards interpretation with final costs back to Tātou

Employment Hero → Tātou

In order to enable the integration, it’s necessary to create webhooks for each entity. They should be created in the origin platform, see direction above.

...

Code Block
languagejson
{
  "tatou_token": <token>,
  "keypayemployment_hero_token": <token>,
  "keypayemployment_hero_business_id": <id>
}

Webhook reference documentation:

...

Code Block
languagejson
// POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/webhookregistrations
{
  "webHookUri": "https://integrations-tatou.app/production/keypayemployment-hero/employee",
  "secret": "",
  "description": "employee-tatou",
  "isPaused": false,
  "filters": [
    "EmployeeTerminated",
    "EmployeeUpdated"
  ],
  "headers": {},
  "properties": {
    "tatou_token": "{{tatou_token}}",
    "keypayemployment_hero_token": "{{keypayemployment_hero_token}}",
    "keypayemployment_hero_business_id": "{{keypayemployment_hero_business_id}}"
  }
}

PayRun webhook on Employment Hero

...

Code Block
languagejson
// POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/webhookregistrations
{
  "webHookUri": "https://integrations-tatou.app/production/keypayemployment-hero/pay-earnings",
  "secret": "",
  "description": "pay-earnings-tatou",
  "isPaused": true,
  "filters": [
    "PayRunFinalised"
  ],
  "headers": {},
  "properties": {
    "tatou_token": "{{tatou_token}}",
    "keypayemployment_hero_token": "{{keypayemployment_hero_token}}",
    "keypayemployment_hero_business_id": "{{keypayemployment_hero_business_id}}"
  }
}

PayPeriod webhook on Tātou

...

Every platform has a different approach for dealing with data structure. In order to fill this gap we created lambda functions, so when creating webhooks you should point them to these functions. Functions are available under the subdomain domain https://integrations-tatou.app/{stage}/keypayproduction/employment-hero/{end-point}.Available stages: dev, staging, production.

Available end points: employee, pay-period, pay-earnings.

...

Filter by label (Content by label)
page
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@957
showSpacefalse
sortmodified
showSpacetypefalsepage
reversetruetype
labelskb-how-to-article
cqllabel = "kb-how-to-article" and type = "page" and space = "KB"labelskb-how-to-article