What are the different statuses connections can be in?

For information on how to find the status of your connection as well as how to find detailed reasoning for why your connection was disabled, please see 📄 How can I monitor and manage connection statuses?

Rutter classifies connections into different statuses based on their health, readiness, and authentication state. These statuses may change as the connection goes through initial and incremental syncs. The below statuses are as displayed on the connections page in the dashboard:

• Healthy: Connection has completed initial sync and endpoints can be called successfully.

• Syncing: The connection is still in its initial sync phase. You will receive an INITIAL_UPDATE webhook when the connection is ready. If you try to fetch data before receiving the INITIAL_UPDATE webhook, you will receive a PRODUCT_NOT_READY error.

• Unhealthy: While syncing data, the connection has encountered errors which may or may not be transient (e.g. rate limits, 404s). Rutter will retry the sync that failed but if we run into repeated failures, the connection may be put into the disabled or needs reauth statuses.

• Disabled: The connection will not sync data and you will be unable to call our API. When a connection is disabled, you will receive a CONNECTION_DISABLED webhook which may contain information about why the connection was disabled.

• Needs Reauth: The connection will not sync data and you will be unable to call our API. However, we believe that reauthentication will fix the issue. This can happen for a variety of reasons, such as the end user disabling the connection or the platform invalidating the connection's credentials. You will receive a CONNECTION_NEEDS_UPDATE webhook when this happens, which will contain a link for the end user to reauthenticate the connection.