> AI agents: this is one page from PostHog's docs. Full index of Markdown docs for LLMs: https://posthog.com/llms.txt

# Linking Sage HR as a source

Canonical URL: https://posthog.com/docs/data-pipelines/sources/sage-hr

> **Cloud region:** This page uses US Cloud hosts. For an EU Cloud project, use `https://eu.posthog.com` instead of `https://us.posthog.com` or `https://app.posthog.com` (app host for links).

## On this page

- [Prerequisites](#prerequisites)
- [Adding a data source](#adding-a-data-source)
- [Sync modes](#sync-modes)
- [Configuration](#configuration)
- [Supported tables](#supported-tables)
- [Troubleshooting](#troubleshooting)

**Beta release**

This source is currently in **beta**. It works end to end, but you may still hit rough edges. [Let us know](https://us.posthog.com/#panel=support%3Asupport%3Adata_warehouse%3A%3Atrue) if you do.

![](https://res.cloudinary.com/dmukukwp6/image/upload/texture_tan_9608fcca70)

![](https://res.cloudinary.com/dmukukwp6/image/upload/texture_tan_dark_a92b0e022d)

Let AI connect your sources for you

Skip the manual setup — run this in your project and the wizard auto-detects your databases and APIs and connects them to PostHog.

`npx @posthog/wizard warehouse`

![PostHog Wizard hedgehog](https://res.cloudinary.com/dmukukwp6/image/upload/wizard_3f8bb7a240.png)

![](https://res.cloudinary.com/dmukukwp6/image/upload/wizard_3f8bb7a240.png)Let AI connect your sources for you

The Sage HR connector syncs employees, terminated employees, termination reasons, and more into the PostHog data warehouse, so you can analyze them alongside your product data.

## Prerequisites

Credentials that can read the data you want to sync. PostHog only reads data, so read access is enough.

## Adding a data source

1.  In PostHog, go to the [Sources tab](https://app.posthog.com/data-management/sources) of the data pipeline section.
2.  Click **\+ New source** and click **Link** next to this source.
3.  Enter your credentials (see [Configuration](#configuration) below) and click **Next**.
4.  Select the tables you want to sync, choose a sync method and frequency, then click **Import**.

Once the syncs are complete, you can start querying this data in PostHog.

Enter your Sage HR company subdomain and API key to pull your HR data.

An admin must first enable API access under **Settings → Integrations → API** in Sage HR, which generates the API key. Requests go to your own subdomain - for `https://yourcompany.sage.hr` the subdomain is `yourcompany`.

You'll be asked for:

-   **Company subdomain**: for example `yourcompany`.
-   **API key**

## Sync modes

Each table can be synced in one of several modes, depending on what the source supports:

-   **Webhook** (when available) – the source pushes changes to PostHog in real time. Fastest freshness, lowest ongoing cost, and the only mode that reliably captures updates and deletes.
-   **Incremental** – only new or updated rows are synced on each run, using a cursor field (such as an `updated_at` timestamp). Cheaper than a full refresh, but deletes aren't captured.
-   **Append only** – new rows are appended using a cursor field; existing rows are never updated. Ideal for immutable, append-only tables like event logs.
-   **Full refresh** – the whole table is reloaded on every sync. Use it when a table has no reliable cursor or when you need deletions reflected.

See [sync methods](https://posthog.com/docs/data-pipelines/sources.md#sync-methods) for a full explanation of how each mode works and how to choose between them.

All Sage HR tables are full refresh. Each sync replaces the contents of the table.

## Configuration

| Option | Type | Required |
| --- | --- | --- |
| `Company subdomain` | text | Yes |
| `API key` | password | Yes |

## Supported tables

| Table | Description | Sync method | Incremental field | Primary key |
| --- | --- | --- | --- | --- |
| `employees` | An active employee, with their contact details, position, team, and employment dates. | Full refresh | — | — |
| `terminated_employees` | A terminated (former) employee, with their identity fields and termination date. | Full refresh | — | — |
| `termination_reasons` | A termination reason configured for the company (e.g. New job). | Full refresh | — | — |
| `teams` | A team in the company, with its managers and members. | Full refresh | — | — |
| `positions` | A job position defined in the company. | Full refresh | — | — |
| `documents` | A document stored in Sage HR, with its file metadata and sharing settings. | Full refresh | — | — |
| `document_categories` | A document category, with the number of documents it contains. | Full refresh | — | — |
| `leave_requests` | A time off request, with its policy, requester, dates, and approval state. | Full refresh | — | — |
| `leave_policies` | A time off policy (e.g. Vacation), with its accrual and allowance settings. | Full refresh | — | — |
| `individual_allowances` | Per-employee time off allowances: each employee's entitlement under each policy. | Full refresh | — | — |
| `onboarding_categories` | An onboarding task category (e.g. General). | Full refresh | — | — |
| `offboarding_categories` | An offboarding task category. | Full refresh | — | — |

## Troubleshooting

-   If the connection fails with an authorization error, the API key is wrong, expired, or has been revoked. Create a new one, then reconnect the source.
-   If a table syncs no rows, the credential may not have access to that data. Check its permissions, then reconnect the source.

If your sync is failing or data looks wrong, see the [Data warehouse troubleshooting guide](https://posthog.com/docs/data-warehouse/troubleshooting.md). If that doesn't help, [contact support](https://us.posthog.com/#panel=support%3Asupport%3Adata_warehouse%3A%3Atrue) – we're happy to help.