Skip to main content

Chift

Availability
Available CoreAvailable StandardAvailable PlusAvailable ProAvailable Enterprise FlexAvailable PyAirbyte
Support Level
Marketplace
Connector Version
0.0.26 (last updated 7 days ago)
Data workers used
0.2 per sync (Learn more)
Definition ID
d03aa64c-21a9-4edc-97b9-5590600ee3d6

This page contains the setup guide and reference information for the Chift source connector.

Chift is a unified API for financial software. Its platform connects your SaaS product to accounting, invoicing, point-of-sale, and other financial tools through consumers (your end customers), connections (a consumer's link to one of those tools), and syncs (data flows that Chift runs between tools). This connector reads that platform metadata, plus the execution history of your syncs, from the Chift API. It doesn't read the financial data (invoices, journal entries, and so on) that flows through those connections.

Prerequisites​

  • A Chift account with access to the Chift platform.
  • A Chift API key. In the Chift platform, open the API Keys page and click Add API Key. Copy the Client ID and Client Secret when you create the key; Chift shows the client secret only once. Your Account ID is shown at the top left of the same page. See Chift's Create and manage API keys guide.

Keep the following in mind when you choose or create the key:

  • The key determines the environment. All keys use the same base URL, but a key created in Chift's Sandbox environment only sees sandbox consumers, and a key created in Production only sees production consumers.
  • Chift lets you restrict a key to one or more consumers. If you use a restricted key, the connector only sees the data that key can access. Use an unrestricted key to sync your whole account.

Setup guide​

  1. In the left navigation bar of the Airbyte UI, click Sources. In the top-right corner, click + New source.
  2. Find and select Chift from the list of available sources.
  3. Enter a Source name of your choosing.
  4. Enter the Client Id, Client Secret, and Account Id from your Chift API key.
  5. Optionally, enter a Start Date in YYYY-MM-DDTHH:MM:SS format, for example 2026-01-01T00:00:00. Only executions that started on or after this date are synced. If you leave it empty, the connector syncs all executions. Other formats, such as a date without a time or a value with a Z suffix, are rejected.
  6. Click Set up source and wait for the tests to complete.

The connector exchanges your credentials for a short-lived bearer token by calling Chift's POST /token endpoint at the start of each sync. If that call fails with a 401 error, check that all three values belong to the same API key and that the key hasn't been deleted.

Supported sync modes​

The Chift source connector supports the following sync modes:

FeatureSupported?
Full Refresh SyncYes
Incremental SyncYes
Replicate Incremental DeletesNo
SSL connectionYes
NamespacesNo

Supported streams​

StreamPrimary keyIncrementalChift endpoint
consumersconsumeridNoGET /consumers
connectionsconnectionidNoGET /consumers/{consumerid}/connections
syncssyncidNoGET /syncs
executionsidYesGET /syncs/{syncid}/executions
  • consumers lists the consumers (your end customers) linked to your account.
  • connections lists every connection, active or inactive, for each consumer returned by consumers. The data field is a free-form object whose keys depend on the integration the connection points to, so its contents vary from row to row.
  • syncs lists the syncs configured for your account, including their connections, mappings, flows, and the consumers they're activated for. The display_condition object inside each mapping's sub_mappings[].target_field is also free-form.
  • executions lists every run of each sync returned by syncs. Each record includes the execution start and end timestamps, its status (for example IN PROGRESS, FINISHED, ERROR, or CANCELED), and the consumer_id and flow_id it ran for. The stream is incremental on the start timestamp and pages through results 50 at a time.

connections and executions are child streams: the connector always reads consumers to build connections, and always reads syncs to build executions, even if you don't select the parent stream.

Limitations and troubleshooting​

  • Chift doesn't rate limit calls to its own API, so the connector doesn't throttle requests. Chift's rate limit documentation covers limits that individual third-party integrations may enforce, but those don't affect the endpoints this connector uses.
  • The executions stream filters on the execution start time only. Executions that started before your Start Date are never synced, even if they finished after it.
  • The connections.data and syncs.mappings[].sub_mappings[].target_field.display_condition objects have no fixed schema. Destinations that write typed files (S3 and GCS in Avro or Parquet format) store them as JSON strings. Destinations that store objects as JSON, VARIANT, or JSONB columns keep the whole object. See the migration guide for details.

IP allow list​

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Reference​

Config fields reference

Field
Type
Property name
Account Id
required
string
account_id
Client Id
required
string
client_id
Client Secret
required
string
client_secret

Changelog​

Expand to review
VersionDatePull RequestSubject
0.1.02026-09-1677576Add executions stream, incremental on start and paginated on page/size. Declare connections.data and target_field.display_condition schemaless, matching Chift's contract, so schematizing destinations (S3/GCS Avro/Parquet) stop dropping their integration-defined keys - see the migration guide
0.0.262026-09-1585978Update dependencies
0.0.252026-09-0885452Update dependencies
0.0.242026-08-1884529Update dependencies
0.0.232026-08-1183887Update dependencies
0.0.222026-08-0483399Update dependencies
0.0.212026-07-2882860Update dependencies
0.0.202026-07-2182371Update dependencies
0.0.192026-07-1481778Update dependencies
0.0.182026-06-3081003Update dependencies
0.0.172026-06-2380430Update dependencies
0.0.162026-06-1679800Update dependencies
0.0.152026-06-0979250Update dependencies
0.0.142026-06-0278653Update dependencies
0.0.132026-04-2877164Update dependencies
0.0.122026-04-2176551Update dependencies
0.0.112026-03-3175769Update dependencies
0.0.102026-03-1775077Update dependencies
0.0.92026-03-1074454Update dependencies
0.0.82026-02-2473822Update dependencies
0.0.72026-02-1773447Update dependencies
0.0.62026-02-1073000Update dependencies
0.0.52026-02-0372704Update dependencies
0.0.42026-01-2072112Update dependencies
0.0.32026-01-1471711Update dependencies
0.0.22025-12-1970944Update dependencies
0.0.12025-10-13Initial release by @FVidalCarneiro via Connector Builder
Was this page helpful?