post
https://api.getknit.dev/v1.0/sync.pause
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
What happens when you pause a sync
By default (without
killOngoingSyncorpauseWebhooks), pausing only pauses the scheduler — the next scheduled sync will not run. Any events from a previously running sync will still keep flowing to your webhook.Use the optional params below to change this behavior:
killOngoingSync: true— immediately terminates the in-progress sync, so its events stop as well (in addition to pausing the scheduler).pauseWebhooks: true— pauses webhook delivery, so no events reach your endpoint while the sync is paused.
You can only pause the scheduler by itself when no sync is currently in progress. If a sync is ongoing and you call this API without
killOngoingSyncorpauseWebhooks, the API returns an error — you must pass at least one of these params to tell Knit how to handle the in-progress sync.
Param combinations
killOngoingSync | pauseWebhooks | Result |
|---|---|---|
false (default) | false (default) | Pauses the scheduler. Errors if a sync is currently in progress — allowed only when no sync is ongoing. |
true | false | Scheduler paused and ongoing sync terminated; webhooks still active. |
false | true | Scheduler paused; ongoing sync continues but its events are not delivered (webhooks paused). |
true | true | Full stop: scheduler paused, ongoing sync terminated, webhook delivery paused. |