← All Connectors
Square

Square

square

POS integration that correlates foot traffic with transaction data. Pulls location-level sales, transaction counts, and customer visit patterns.

Configuration schema

FieldTypeRequiredDescription
access_tokenstringYesSquare access token from the Square Developer Dashboard.
location_idstringYesSquare location ID for the venue.

Setup instructions

1

Create an application in the Square Developer Dashboard.

2

Generate a production access token with Payments and Orders read permissions.

3

Note your Location ID from the Locations API or Dashboard.

4

Register the integration via POST /api/venues/:id/integrations with connector_type "square".

5

The connector polls Square APIs at configurable intervals for transaction data.

Webhook / polling format

square-webhook.json
// Square uses polling, not webhooks for this integration
// The connector calls these endpoints:
// GET /v2/locations/{id}        — location details
// GET /v2/orders/search         — recent transactions
// GET /v2/customers/search      — customer data

Normalized canonical event

After normalization, the connector output becomes a standard GNCanonicalEvent:

canonical-event.json
{
  "event_type": "device_connected",
  "venue_id": "v_jkl012",
  "zone_id": null,
  "device_hash": "hmac_sha256_transaction_id",
  "timestamp": "2026-03-15T18:15:00.000Z",
  "connector_type": "square",
  "metadata": {
    "transaction_total": 24.50,
    "item_count": 3,
    "payment_method": "card"
  }
}

Next steps