Initiates an incremental sync job for the Pipeline, rather than waiting for the next scheduled run. Read Sync Now for more information about the actions performed on your Pipeline when you sync it on demand. If the schedule.sync_type of a Pipeline is ON_DEMAND, Hevo does not run syncs on a schedule. Use this endpoint to start a sync. Enabling or resyncing such a Pipeline also starts a sync.
Hevo runs the sync as a job. The state of the Pipeline remains Initialized while the sync is in progress. To check the progress of the sync, use the List All Jobs for a Pipeline endpoint, or the runs.active field returned by the Get Details of a Pipeline endpoint.
Refer to Triggering a Sync for more information about when and how to trigger a sync.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
The sync could not be initiated. This occurs when the Pipeline is not in the Initialized state.
You do not have the permission to run this action on a Pipeline. Ask your team administrator for a role that allows it.
The Pipeline could not be found. This occurs when:
- No Pipeline exists with the specified
pipeline_id, or you do not have access to it. - The Pipeline is deleted, or its deletion is in progress.
- The Pipeline is in a different region from the base URL that you call.
The sync could not be initiated. This occurs when:
- A job is already running for this Pipeline. Wait for it to finish, or cancel it using the Cancel a Pipeline Job endpoint.
- An edit of the Pipeline is being applied.
- The Pipeline is changing state.
Retry the request once the job, the edit or the state change finishes.