Connectors can be triggered manually or automatically by the Yext system. Available trigger types vary by connector source.
All connectors except Push to API can only have one run in progress at a time. If a run is already in progress and a second trigger is attempted, the second run will not start. This applies to scheduled runs as well — if a manual run is in progress when a scheduled run is due, the scheduled run will be skipped.
All trigger types support dry runs and any run mode (Default, Deletion, or Comprehensive).
Below is a table of the available connector triggers and the connector sources they are compatible with (scroll horizontally to view):
| Manual - In Platform | Manual - Via API | Scheduled Runs | Linked Connectors | Crawler Completion | |
|---|---|---|---|---|---|
| All Native Sources |  |
|
|
|
 |
| Crawler | |
|
|
|
|
| File Upload | |
|
|
|
|
| Function | |
|
|
|
|
| FTP/SFTP | |
|
|
|
|
| Pull from API | |
|
|
|
|
| Push to API | |
|
|
|
Manual Triggers
Via the Platform
A user can trigger a connector run manually from the Yext platform. The triggering user is recorded in the run results.
Eligible sources: Pull from API, Crawler, Function, File Upload, FTP/SFTP, and all native sources.
Via API
Use the /trigger endpoint for: Pull from API, Crawler, Function, File Upload, FTP/SFTP, and all native sources.
Use the /pushData endpoint for Push to API connectors.
System Automated Triggers
Scheduled Runs
Triggers a connector run at a set frequency (e.g., daily, weekly, monthly). See Scheduled Runs for configuration details.
Eligible sources: Pull from API, Function, FTP/SFTP, and all native sources.
Linked Connector Runs
Triggers a connector run when a different connector completes. For example, if you want Connector B to run when Connector A is completed, you can configure Connector B’s settings to specify Connector A as the linked connector.
It may take up to two minutes after the linked connector completes for the next run to trigger.
The linked connector must finish with a Completed or Completed with Errors status to trigger the next run. Runs ending in Canceled, Aborted, Failed, or Ready for Review will not trigger it.
Eligible sources: Pull from API, Crawler, Function, FTP/SFTP, and all native sources.
Crawler Completion
Triggers a connector run whenever its source crawler completes a crawl. Both of the following conditions must be met:
- At least one page in the crawl must have an update detected. If no updates are detected, the connector will not run.
- The crawl must be fully completed. Canceled or in-progress crawls will not trigger a run.