Menu
UnpackData Docs

API Connectors

Bring in data from online services such as Stripe and Shopify. Each connector asks for its own sign-in details, and you choose which objects to sync into tables.

How this differs from Connections

Connections link to a database. API Connectors link to online services such as Stripe, Shopify, QuickBooks and Zendesk. You can use both in datasets, queries, charts, and alerts.

Add an API connector

  1. Open API Connectors and click Add Connector.
  2. Name the connector. Enter a Name (placeholder suggests e.g. My Stripe Account) and a Description.
  3. Pick the Connector Type. The type you pick decides which sign-in fields appear next.
  4. Fill in API Credentials. Fields vary by connector, for example: API Key, Access Token, Store URL, Instance URL, Company ID (Realm ID), Zendesk URL, Admin Email.
  5. Pick Objects to Sync. Check each object the connector should bring in. Objects tagged full refresh only can't use Incremental sync.
  6. Choose a Sync Mode. Full Refresh reloads every row every run, Incremental only brings in changes since the last sync.
  7. Test and save. Click Test Connection, then Save.

Manage existing connectors

  • Edit: update credentials, object selection, or sync mode.
  • Sync: run the connector on demand.
  • Logs: open the Sync History panel with a row per run, showing Object, Status (Success, Failed, or Running), Rows, Started, and any Error. Useful when something went wrong.
  • Delete: remove the connector once nothing depends on it.