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

# Linking Omni Analytics as a source

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

> **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 Omni Analytics connector syncs your [Omni](https://omni.co/) workspace data into PostHog, so you can analyze your BI documents, folders, connections, schedules, users, and user groups alongside your product data.

## Prerequisites

You need an Omni Analytics account with API access. You can use either an **Organization API key** or a **Personal Access Token**, but Organization API keys provide broader coverage:

-   **Organization API key** – access all tables, including Users and User groups (SCIM endpoints). Create one under **Settings > API access** in Omni.
-   **Personal Access Token** – access most tables, but can't read Users or User groups. Only sees content the token owner can access.

## 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.

When linking Omni Analytics, you'll need:

-   **Instance URL** – your Omni instance URL, for example `https://your-company.omniapp.co`.
-   **API key** – an Organization API key or Personal Access Token from your Omni account.

## 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.

The Documents table supports incremental sync via the `updatedAt` field. All other tables are full refresh only, since the Omni API doesn't expose incremental sync filters for them.

## Configuration

| Option | Type | Required |
| --- | --- | --- |
| `Instance URL` | text | Yes |
| `API key` | password | Yes |

## Supported tables

| Table | Description | Sync method | Incremental field | Primary key |
| --- | --- | --- | --- | --- |
| `Documents` | Dashboards and workbooks in your Omni instance, with their owner, folder, and access scope. | Incremental, Full refresh | updatedAt | — |
| `Folders` | Folders organizing documents in your Omni instance. | Full refresh | — | — |
| `Connections` | Database connections configured in your Omni instance. | Full refresh | — | — |
| `Schedules` | Scheduled deliveries and alerts configured for dashboards in your Omni instance. | Full refresh | — | — |
| `Users` | Users provisioned in your Omni organization (SCIM). | Full refresh | — | — |
| `UserGroups` | User groups provisioned in your Omni organization (SCIM). | Full refresh | — | — |

## Troubleshooting

-   If you get an authorization error, your API key is invalid or expired. Generate a new key in Omni under **Settings > API access** and reconnect.
-   If you get a permission error, your API key doesn't have access to the requested data. Check the key's permissions and try again.
-   If the Users or User groups tables fail, make sure you're using an Organization API key. Personal Access Tokens can't access SCIM user and group endpoints.
-   If PostHog can't reach your Omni instance, check that the Instance URL is correct and points to your Omni deployment.

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.