All Stitch integrations run on a schedule, but Stitch can also start and stop an integration on demand. This is useful for testing configuration changes or recovering from an error.

In this guide, we’ll cover:

About replication jobs

When starting or stopping replication jobs, keep the following in mind:

  1. Manually starting and stopping replication jobs is only available for Singer-powered integrations. As integrations are converted to the Singer system, these features will be made available.
  2. Only one replication job may run at a time for an integration. If a job is in progress, you will not be able to start a new job without first stopping the one that is in progress.
  3. Canceling a replication job won’t stop data that has already been extracted from loading. Canceling an in progress job only cancels the remaining portion of the Extraction phase. Any data extracted prior to the cancellation will be loaded to your destination.

Start a manual replication job

You can manually start a replication job for any Singer-powered integration, regardless of whether the integration is active or paused. Starting a replication job for a paused integration won’t change its paused status, so you can kick off jobs as needed.

To manually start a replication job, click into an integration’s Extractions tab and then click the Run Extraction Now button:

Manually starting a replication job.

If successful, an Extraction starting now banner will display and the replication job will kick off shortly.

Stop an in progress replication job

You can stop any in progress replication job, whether it was manually started by you or automatically started by Stitch.

To stop a replication job that is currently in progress:

  1. Scroll to the Extraction Logs section of the Extractions tab. The first item in this section will have an In Progress status and a Stop Extraction button:

    An In Progress replication job and Stop Extraction button, highlighted

    Note: The Stop Extraction button will only display when a replication job is currently running.

  2. Click Stop Extraction. You’ll be asked to confirm the job cancellation.
  3. To continue, click the Stop Extraction button.

Stitch will cancel the remainder of the Extraction phase of the replication job. Note: This will not cancel the loading of data that has already been extracted. Any data extracted prior to the cancellation will be loaded to your destination.

Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.