Run Modes | Yext Hitchhikers Platform

There are three different “Run Modes” to choose from when running a Connector:

• Default
• Comprehensive
• Deletion

Default

• New entities present in the run will be created.
• Existing entities will be updated (or remain unchanged).
• No entities will be deleted.

This works for Connectors that expect to ingest new data and update existing data, without the assumption that missing data should be deleted.

Comprehensive

If the Run Mode is Comprehensive, the Connector will treat each run as a comprehensive data set.

• New entities present in the run will be created.
• Existing entities will be updated (or remain unchanged).
• Any entities that were created in a previous run of the same Connector, but are not present in the current run, will be deleted.

Use Case

This will work well for Connectors that expect to fetch the entire data set each time it is run. Anything missing from that data set has presumably been deleted from the source system and will be deleted in Yext.

Nuances

If a connector running in comprehensive mode has an ETL error at any ANY point, including during the transform stage, the entire run will fail. In this case, NO entities will be created, updated, or deleted

Deletion

If the Run Mode is Deletion, the Connector will delete every entity supplied in that run.

• No entities will be created, updated, or unchanged.
• If an entity ID is sent in the data set that matches that of an entity ID in Yext, that entity will be deleted.

Use Case

This will work well for Push Connectors that need to delete specific entities when they are deleted in the source system, and each Push is not a comprehensive set of data. It is very unlikely that this would be used for a Pull Connector unless the desire was to delete all entities created by the Connector (e.g., if a mistake was made in the configuration and you wanted to start again).

Setting the Run Mode

Scheduled Runs

All Scheduled Runs will have a Run Mode tied to the schedule (or automated run). Schedules can be set on certain sources, including:

• Pull from API
• Crawler
• Functions
• Any Native Source

Each time the Connector runs on its schedule, it will run in the specified mode. The mode can be either Default or Comprehensive Mode (Deletion is not supported for scheduled runs).

Run Now

When triggering a run on-demand via the “Run Now” button, use the combo-button to specify the mode to run the Connector (Default, Comprehensive, or Deletion).

The Primary “Run Now” action will always trigger a run in Default mode.

API Support

Push Connectors: POST /pushData

Push Connectors run when data is sent to the {connectorId}/pushData endpoint.

Use the runMode query parameter to specify the Run Mode:

• DEFAULT
• COMPREHENSIVE
• DELETION

If omitted, the runMode will default to DEFAULT.

To run the Connector in Deletion or Comprehensive Mode, the query parameter must be set every time a request is sent.

POST /trigger

The trigger endpoint can be used to trigger a Connector run via the API for sources including Pull, Crawler, Function, File Upload, and Native Sources.

Use the runMode query parameter for the {connectorId}/trigger endpoint to specify the Run Mode:

• DEFAULT
• COMPREHENSIVE
• DELETION

If omitted, the runMode will default to DEFAULT.