Loading...
Loading...
A Connection in Quiltt serves as the primary way to ingest and sync financial data associated with one of your Profiles. Connections are typically created from a data source like Finicity, MX or Plaid, and provide access to account information, transactions and other data, depending on the provider and Connection configuration.
After a Connection is created, Quiltt will automatically ingest permissioned data, keep it in sync, and make its data available via the GraphQL API.
Metadata
Profile GraphQL API Reference
connectionLooks up a specific Connection by its ID:
connectionsLists the Connections associated with the Profile:
The connections query supports various filtering options:
Filters for Connections with specific statuses:
Filters for Connections from specific providers:
Filters for Connections with specific metadata, such as an internal ID:
Connection mutations allow you to disconnect or update individual Connections.
connectionDisconnectDisconnect a Connection from its provider, preventing Quiltt from syncing data:
connectionUpdateUpdates a Connection with new metadata. This is useful for storing additional information about the Connection, such as a user-friendly name, or an internal ID.
Note that updating a Connection's products requires the end-user going through the Connector Reconnect flow.
Connection subscriptions allow you to listen to Connection sync events.
connectionSyncedFires whenever an existing Connection finishes syncing:
connection.createdThis event fires once a new Connection is created on a Profile.
connection.synced.successfulThis event fires when a Connection is successfully synced with the provider. The Connection status will resolve to SYNCED.
connection.synced.successful.initialThis event fires once after the first quick sync is completed on a Connection. The Connection status will resolve to SYNCED.
connection.synced.successful.historicalThis event fires after historical data is synced following a successful Connector session. This includes both initial connections and Reconnect flows. The event metadata includes startDate and endDate indicating the historical period that was synced. The Connection status will resolve to SYNCED.
connection.synced.errored.repairableThis event fires when a Connection becomes ERROR_REPAIRABLE and requires user action to resume syncing. Have the user complete the Connector Reconnect flow to resolve this error. The Connection status will resolve to ERROR_REPAIRABLE.
connection.synced.errored.institutionThis event fires when the provider is reporting an error with the connected Institution. The Connection status will resolve to ERROR_INSTITUTION.
connection.synced.errored.providerThis event fires when the Connection provider is reporting an error with the Connection. Inspect the Connection's Remote Data for more information. The Connection status will resolve to ERROR_PROVIDER.
connection.synced.errored.serviceThis event fires when an unexpected error occurs attempting to sync the Connection. Visit our Status page or contact Quiltt Support for more information. The Connection status will resolve to ERROR_SERVICE.
connection.disconnectedThis event fires when a Connection has been fully disconnected from the provider. The Connection status will resolve to DISCONNECTED. If the Connection has been deduplicated, it will be removed from the system.
When Connections enter an error state, regular syncing will be interrupted and on-demand API calls like Balance Refreshes will fail until the Connection error is resolved. You can monitor the health of your connections by checking the Connection.status field in GraphQL or by subscribing to Connection webhooks.
Follow the below steps to troubleshoot and resolve Connection errors based on their status:
ERROR_REPAIRABLEERROR_INSTITUTIONHave the user confirm that they are:
If your Connector uses the Account Owners or Account Statements products, make sure the user confirms they have enrolled into Electronic Statements delivery.
ERROR_PROVIDERERROR_SERVICE