How to Trigger Syncs Manually
To enable manual sync scheduling for a connection, specify manual
as a value of the schedule_type
parameter using the Update a Connection endpoint. The manual sync scheduling ignores the set sync_frequency
.
IMPORTANT: Sync rescheduling only works with automatic sync scheduling. You must manually trigger your syncs after you set the sync scheduling for your connection to
manual
. If a manually-triggered sync wasrescheduled
, you must manually re-trigger that sync.
For example, let's say we want to enable manual sync scheduling for connection connection_id_1
and trigger its sync.
Use the example request below to switch your connection's
schedule_type
tomanual
:PATCH https://api.fivetran.com/v1/connections/connection_id_1
{ "schedule_type": "manual", "run_setup_tests": false }
Next, use the Sync Connection Data endpoint to trigger a data sync according to your own schedule. Alternatively, you can trigger a sync in your Fivetran dashboard.
POST https://api.fivetran.com/v1/connections/{connection_id}/sync
{ "force": true }
NOTE: Using the
"force": true
payload parameter in the request stops a sync that is in progress. Leave the payload empty if you don't want to stop a current sync.