Linking Yoco as a source

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.

Learn more
PostHog Wizard hedgehog

Contents

Alpha release

This source is currently in alpha. The interface and available tables may change.

The Yoco connector syncs payments, orders, refunds, 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 of the data pipeline section.
  2. Click + New source and click Link next to this source.
  3. Enter your credentials (see 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.

Import payments, orders, refunds, payouts, catalogue, and staff from your Yoco business.

Create an API key in the Yoco Developer Console. Give the key the scopes for the tables you want to sync: business/orders:read for payments, orders, refunds, and payment links, business/payouts:read for payouts and payout entries, business/catalogue:read for items, categories, brands, and modifier groups, business/locations:read for locations, business/staff:read for staff, and business/devices:read for card machines.

You'll be asked for:

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 for a full explanation of how each mode works and how to choose between them.

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

Configuration

OptionDescription
API key
Type: password
Required: True

Create a key in the Yoco Developer Console.

Supported tables

TableDescriptionSync methodIncremental fieldPrimary key
payments

Money collected from a customer, in person on a card machine or online through checkout.

Incremental, Full refreshupdated_at, created_at—
orders

A sale recorded on the point of sale or online, with its line items, payments and refunds.

Incremental, Full refreshupdated_at, created_at—
refunds

Money returned to a customer against an earlier payment.

Incremental, Full refreshupdated_at, created_at—
payouts

A batch of settled transactions paid out to the business bank account.

Incremental, Full refreshupdated_at, created_at—
payout_entries

A single transaction that makes up a payout, mapping payments, refunds and fees to the batch they settled in.

Full refresh——
payment_links

A shareable link that lets a customer pay online without a checkout integration.

Incremental, Full refreshupdated_at, created_at—
items

A product or service in the business catalogue, with its variants, options and pricing.

Incremental, Full refreshupdated_at, created_at—
item_categories

A grouping of catalogue items, used to organise the point of sale.

Incremental, Full refreshupdated_at, created_at—
item_brands

A brand that catalogue products can be attributed to.

Incremental, Full refreshupdated_at, created_at—
modifier_groups

A set of modifiers, such as extras or sizes, that customers can pick from when ordering an item.

Incremental, Full refreshcreated_at—
locations

A trading location of the business, used to attribute orders and catalogue availability.

Full refresh——
staff

A staff member of the business, used to attribute payments, orders and refunds.

Incremental, Full refreshupdated_at, created_at—
card_machines

A Yoco card machine registered to the business.

Incremental, Full refreshupdated_at, created_at—

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. If that doesn't help, contact support – we're happy to help.

Still have questions?

Was this page useful?