Linking Square as a source
The Square connector syncs payments, refunds, customers, locations, and catalog data from your Square account into PostHog.
Adding a data source
Go to the sources tab of the data pipeline section in PostHog.
Click + New source and then click Link next to Square.
You need a Personal Access Token from Square. In the Square Developer Dashboard, open your application (or create one) and navigate to Credentials. Copy your Personal Access Token.
Grant the following read permissions for the data you want to sync:
PAYMENTS_READ– payments and refundsCUSTOMERS_READ– customersMERCHANT_PROFILE_READ– locationsITEMS_READ– catalog
Back in PostHog, paste the access token into the Access token field and select your Environment:
- Production – for live Square data (
connect.squareup.com) - Sandbox – for test data (
connect.squareupsandbox.com)
- Production – for live Square data (
Click Next. Select the tables you want to sync and configure the sync method and frequency. Click Import.
Once the syncs are complete, you can start using Square data in PostHog.
Configuration
| Option | Type | Required |
|---|---|---|
Access token | password | Yes |
Environment | select | Yes |
Supported tables
| Table | Description | Sync method | Incremental field | Primary key |
|---|---|---|---|---|
payments | A payment taken by the seller, representing a single attempt to collect money from a customer. | Incremental, Full refresh | created_at | — |
refunds | A refund of all or part of a previously processed Square payment. | Incremental, Full refresh | created_at | — |
customers | A customer profile in the seller's Square Customer Directory. | Full refresh | — | — |
locations | A business location (store) belonging to the Square seller account. | Full refresh | — | — |
catalog | A catalog object — an item, variation, category, tax, discount, or modifier in the seller's catalog. | Full refresh | — | — |
Sync methods
The payments and refunds tables support incremental syncing using created_at as the replication key. This means only new records are fetched on each sync.
The customers, locations, and catalog tables sync via full table refresh only. Square's API doesn't expose a server-side time filter for these resources on their GET endpoints.
Note: The
catalogtable includes items, categories, taxes, and other catalog objects from your Square account.