Skip to main content

Connect KeyPay

Import your workers from KeyPay — now branded Employment Hero Payroll. You give Oho a read-only API key once, and Oho creates your workers and keeps them in step with KeyPay on the schedule you choose — so people don't have to be added in two places.

KeyPay is in Beta

This connector is still being rolled out. It imports employees and their status (active or terminated) from one KeyPay business — not job or manager detail yet. If you hit something unexpected, contact support@weareoho.com.

What you'll end up with

Your KeyPay employees in Oho as workers — each ready for credentials to be added and checked — kept in step with KeyPay, without maintaining two lists.

Before you start​

You'll need:

  • Your people already recorded in the KeyPay business you want to import, with the details you want in Oho — their names and email addresses.
  • A KeyPay login on that business that can generate an API key, or someone who has one. This is done inside KeyPay, not in Oho.
  • To know which region hosts the business. Australia is the default; a business hosted elsewhere needs its region's host set in Step 2.
One business per connection

Every KeyPay employee endpoint is scoped to a single business. If you run several businesses in KeyPay, set up one Oho connection per business.

Step 1: Get your auth details​

What you'll need for this step

A KeyPay login on the business you're importing. You'll finish this step holding two values to paste into Oho: an API key and a business ID.

KeyPay uses the API key pattern: you generate a key in KeyPay and paste it into Oho. There's no sign-in redirect and nothing for Oho to refresh.

  1. In KeyPay, go to My Account → API and generate a new API key. Copy it now — KeyPay shows the key once.
  2. Open the business you want to import and copy its Business ID — the numeric id in the KeyPay URL when you're viewing that business.
Technical detail: auth, business scope, region & pagination

Hand these points to whoever administers KeyPay — a non-technical admin can skip them.

  • Auth. The API key is sent as the HTTP Basic auth username with a blank password. See KeyPay's API keys guide.
  • Business scope. Employees are read from GET /api/v2/business/{businessId}/employee/unstructured. The business ID is also available from GET /api/v2/business.
  • Region. The host is region-specific. Australia is https://api.keypay.com.au (the default); other regions use their own host, for example https://apinz.keypay.com.au for New Zealand. Set Base URL accordingly for a non-AU business.
  • Pagination. The employee list is OData-paginated with $top (capped at 100) and $skip; Oho pages through automatically and caps its own request rate below KeyPay's throttling.
  • Where secrets live. Oho stores the API key encrypted, referenced by a stored secret ref; the browser never handles it after you paste it.
Treat the API key like a password

It grants ongoing read access to worker PII for as long as it's valid. Never post it in email, chat, or a ticket, and revoke it in KeyPay if the connection is removed or someone with access to it leaves.

Expected outcome: you have the API key and the business ID copied, ready to paste into Oho.

Step 2: Connect it in Oho​

In the left menu under Admin, click Integrations, then start a new integration.

The Integrations page in Oho

Pick KeyPay from the list of sources.

Choosing a source in Oho

Paste your API Key and Business ID, then continue. Two settings sit alongside them:

  • Base URL — leave it as it comes for an Australian business; set your region's KeyPay host otherwise.
  • Active Employees Only — off by default, so terminated employees import and are marked inactive rather than silently disappearing from Oho. Turn it on to import active employees only.

Expected outcome: the KeyPay connection is accepted in Oho, and it moves you on to field mapping.

Step 3: Map your fields​

Oho creates one worker per KeyPay employee. It recognises a returning worker by their KeyPay employee ID, carried on source.externalId — so a re-sync updates the existing worker in place rather than creating a duplicate.

The KeyPay business name becomes the worker's organisation in Oho. The setup screen asks you to line each KeyPay value up with its Oho equivalent before your first sync. For what each field expects, which are required, and how re-syncs avoid duplicates, see the shared Map your fields reference, and the KeyPay integration reference for what this connector imports at a glance.

Map every value, or those records won't land where you expect

A KeyPay value you leave unmapped still imports, but Oho can't place it correctly until it's mapped. If a new value appears in KeyPay later, Oho flags it so you can map it.

Expected outcome: every KeyPay value the setup screen lists maps to its Oho equivalent, and each worker carries their KeyPay employee ID as the match key.

Step 4: Set the schedule​

Choose how often the sync runs, then name it and save.

  • Once — a one-off load to get started. You can revoke the API key in KeyPay afterwards if you don't intend to sync again.
  • Recurring — Oho re-reads KeyPay on a schedule, so new starters and terminations flow through automatically. The API key from Step 1 must stay valid for future runs.

Setting the sync schedule

Expected outcome: the connection is saved and scheduled, and appears in your Integrations list.

Step 5: Run & verify your first sync​

Run it now with Save & Run, or wait for the first scheduled run. Once it's run, confirm your people are in: they appear under All Workers, and each credential you later add is checked against its official source (see One-off verification).

The new connection in your Integrations list

If the run didn't bring everyone in, check the run history and the Common questions below.

Expected outcome: your people are in Oho under All Workers, ready for credentials to be added and checked.

What happens next​

  • Your people appear under All Workers, ready for checks.
  • To keep those checks current, add a verification source for the credential types you hold — synced credentials then verify at the register automatically.
  • If recurring, you don't re-import by hand — change it in KeyPay and Oho picks it up on the next run.

Common questions​

The sync found nothing. Check the API key hasn't been revoked in KeyPay, and that the Base URL matches the region hosting the business — an Australian host won't find a New Zealand business.

The wrong people imported. Each connection reads one business. Confirm the Business ID is the one in the KeyPay URL for the business you meant, and add a separate connection for each additional business.

Terminated staff are missing. Active Employees Only may be turned on. Turn it off and re-run, and terminated employees import marked inactive.

Some workers didn't import. Oho matches returning workers on their KeyPay employee ID (source.externalId). Check the match key and the values you mapped in Step 3.

I don't see Integrations. This is an admin area — if it's not in your menu, ask an admin in your organisation, or contact support@weareoho.com.