Triggers

A trigger defines what causes a flow to run.

Each flow requires exactly one trigger, which starts the first flow step when the criteria for the trigger are met. There are four types of flow triggers, each of which has multiple use cases.

• Action Close Out

• Cache Event

• On-Demand

• Work Request Batch Ready

Action Close Out Trigger

An action close out trigger runs a flow on the success or failure of a connector action. You can also use an action close out trigger to run a flow on either a successful or failed run. It is common practice to send a close out to the source system on the success of an action or to remediate the data so an action can be retried on failure.

For instructions on adding a cache event trigger, see Add an Action Close Out Trigger.

Cache Event Trigger

A Cache event trigger runs a flow as soon as there is a Create, Update, or Delete of the connector's data object selected in the trigger.

Completed actions also cache write data. In situations where data is maintained bidirectionally, it is important to set the Event Origin to indicate where the data was changed. Select the name of the connector to indicate changes made directly to the data from the external system. Select Ryvit to indicate changes made to the data via an internal action from the App Xchange platform. This will prevent loops where you update one system and then immediately update the other system.

Cache event triggers can also be filtered to further define the specific conditions under which the flow will trigger. This ensures that the flow runs only when relevant criteria are satisfied, reducing the number of costly flow runs. Values entered will be compared as text strings. Filters cannot contain code, such as a reference to a flow config.

For instructions on adding a cache event trigger, see Add a Cache Event Trigger.

On-Demand Trigger

An on-demand trigger can operate in several ways. It can be run manually, scheduled to run at an interval of your choosing, or, when used within a called flow, it may be run from inside another flow. It may also have a custom input of data.

Of these scenarios, on-demand triggers are most commonly used for callable flows. They can simplify flow writing and make flows more reusable. For more information, see Callable Flows.

For example, imagine an integration that sends many different types of data between two systems, and one of the systems requires each of these data types to respond with a message on success or failure.

In this scenario, writing one called flow allows you to call that flow in each of the other data syncs. This reduces the number of steps in each flow and allows you to manage any issues with that close-out logic in one place.

You can even edit the input schema on the trigger. For example, if you want an on-demand flow to send an email to receive context details or error messages.

For instructions on adding an on-demand trigger, see Add an On-Demand Trigger.

Work Request Batch Ready Trigger

The work request batch ready trigger runs when a batch of work requests reaches a state where they are ready to process. This trigger is commonly used when writing flows that combine work request cache events into a single batch. See Work Tracking for more details.

You can customize this trigger in several ways. You can define a certain type of work request to trigger the batch, the target status for these work requests, and set a batch size limit. You can also configure the timeout length after which the flow will automatically run.

This trigger outputs an array of work requests. See below for an example of a typical JavaScript output array.