Help Center
Connectors

How do I get alerted when a connector breaks?

Updated 5 days ago

Subscribe to the connector_sync_error webhook. It fires the moment a sync fails, and when connector.connector_status in the payload is RELINK_NEEDED, your customer needs to relink the connector.

Without an alert, a broken connector is easy to miss: your API reads keep returning the last synced data with a 200, so stale data looks current.

Webhooks to subscribe to

Webhook

Use it to

connector_sync_error

Catch failed syncs. Its error object has the failure time and a summary

connector_sync_started

Spot delays by comparing the actual start time with the connector's expected schedule

connector_synced

Start your own processing only after a sync has finished

Set them up in the dashboard under Configure > Webhooks. See Webhooks for payloads and delivery.

What to do with each alert

  1. Read connector.connector_status in the connector_sync_error payload.

  2. If it's RELINK_NEEDED, ask your customer to relink. See How do I fix a connector that shows "Relink Needed"?

  3. If it's anything else, the next scheduled sync retries on its own. Read the error summary, and check the connector's Sync tab if the failure repeats.

  4. If connector_sync_started hasn't arrived within the window you expect, trigger a sync with the Force Resync API.

Webhook deliveries stop retrying after about 60 seconds. Back up your alerts with a regular check of status and sync_status from Get Connectors, so a missed delivery doesn't hide a broken connector.

Was this helpful?
Was this helpful?