# Test, start, and stop recipe


In Workato, you can work with recipes in various ways:

  • test a recipe to run a single trigger event through the recipe logic
  • start a recipe to have it pick up trigger events
  • stop a recipe to have it stop processing new trigger events
  • use skip step to build and test your recipes incrementally

# Test mode

Workato has an integrated build and test environment to enable users to test their recipes soon and frequently in the development process.

To enter the Test Mode, move the “Recipe/Test Jobs” slider to the “Test Mode”. Return it to “Recipes” to re-enter the build / edit mode.

Default test button Mode: Recipe editor

Default test button Mode: Test job

It is best practice to test your recipe before starting it and letting it run with minimal supervision. You don't want to turn on an inaccurate automation that moves and processes data wrong - that probably requires a lot of cleanup!

The test recipe button picks up a single trigger event and runs it through your recipe to create a job. This lets you review the job details to check for recipe correctness.

# Test trigger events

The trigger event picked up when you select test depends on the When first started, this recipe should pick up events from configuration selected. In the following example, clicking on test will have the recipe look for Salesforce accounts created or updated after 1 Feb 2020, midnight. If the recipe test mode finds Salesforce accounts matching that criteria, it proceeds to process the first trigger event in the queue. As trigger events are processed in chronological order, the account created or updated earliest (closest to 1 Feb 2020, midnight) will be processed.

No jobs when testing Recipe test mode looks for Salesforce accounts created or updated after 1 January 2017, midnight, and processes the earliest trigger event in the list of accounts found matching this criteria

Remember, the Since/From date cannot be changed once you have tested/started the recipe!

  • If you enter the Test Mode without setting up a trigger, it will display the following message. Test without trigger Test without trigger

  • If you enter the Test Mode without conducting a test of your recipe, it will display the following message. Select Test button to run a test. Test not started Test not started

  • When a test is in progress, the following message will be displayed. Test in progress Test in progress

# Cancelling a test job

You can cancel a test job by clicking on the cancel button in the test mode. The following message will be displayed while the job is being canceled.

Cancel test job Cancel test job

Once a job is canceled, the view in the Test Mode will be as follows.

View cancelled job View cancelled job


If the test mode did not find any jobs, it returns the following message.

In our example, it means that there are no Salesforce accounts created or updated after 1 January 2017, midnight. In this case, there are a couple of things we can do:

  1. Create or update an app account to create a trigger event, then select test again. The recipe should pick up this trigger event as it fits the criteria of an account that has been created or updated since 1 Feb 2020, midnight.

  2. Make a copy of the recipe, and change the since date to an earlier date where you know there will be trigger events. For example, if I know that I have an app account created on 31 Dec 2016, 10.30 pm, I can set the copied recipe's since date to earlier than 31 Dec 2017, 10.30 pm, to guarantee that I have at least 1 trigger event to pick up.

If the test mode finds trigger events, it picks up and processes the first trigger event. As trigger events are processed in chronological order, the earliest event will be processed. If you select test again, it will process the next trigger event in chronological order, and so on.

# Test Results

If your test is successful, you will be able to see the test path of the recipe run as well as the Input, Output, and Debug information in the Test Mode. Please refer to the following example of a successful test run.

View successful job View successful job

If a test run is not successful, the Test Mode will display the step at which the error occurred and a description of the error. The step at which the recipe failed will be highlighted. Select the step to view details.

View failed job View failed job

You can fix the errors in build mode before choosing to repeat the test job.

# Test jobs and repeat jobs

A test job is a job conducted in a testing environment that uses new trigger data from the trigger application. Conducting a new test job uses new trigger data. A repeat job is one where the same trigger data is reused for conducting the test. Workato allows the user to conduct new test jobs as well as repeat jobs. The Test Mode display both the test job number as well as the repeat number (if the test has been repeated) for any test conducted on a recipe.

In the following example, the results for test job number 3267450 and repeat number 1 are displayed.

Repeat job Repeat job

You can access previous test jobs by using the drop down menu provided.

View past jobs View past jobs

# View all past jobs

For a full list of test jobs, please select see all test jobs for a view of the job table.

View all past jobs View all past jobs

Similarly, the repeat history for any test job can be found at the drop down menu for repeat jobs.

View past repeat jobs View past repeat jobs

# Testing tips

# Use sandboxes

As best practice, try to use sandboxes instead of production accounts for testing recipes. This ensures that you're using realistic data but not working with production, possibly mission-critical data.

# Build your recipe incrementally

Build your recipe incrementally and test at logical intervals. Building and testing small segments of the recipe at a time ensures that the recipe flow is coherent and the datapills are mapped properly. It also makes debugging easier.

Build your recipes incrementally with skip step

Skip steps allows you to ignore steps when running a recipe. This is very useful when you’re trying to build a recipe, and only want to test a part of it.

Learn more about how to use skip step here.

# Test all possible scenarios

Recipes often come with multiple lines of conditional logic. Check that there are no missing conditions in your recipe flow. For example, handing cases where Emails is present and when it is not present.

# Test all mapped data fields and pills

To ensure data is being transformed (if applicable) and moved from one app to the other correctly, test all data being moved. For example, in the following recipe, we're moving Account Name, Account Description and Account Phone from Salesforce into Zendesk. During testing, best practice is to ensure that these three data fields in Salesforce has data, and then verify that these input fields in Zendesk (Name, Details, and Phone) has the right data moved from Salesforce.

# Start recipe

Starting a recipe will cause it to pick up trigger events and process them through the recipe. When a recipe is started, it becomes active.

# Starting a recipe for the first time

When a recipe is first started, it will fetch trigger events from the When first started, this recipe should pick up events from configuration. Subsequently, it will continuously process these events. If you had defined the Since/From date during testing previously, this date cannot be changed again for this recipe - learn more here.

If you had tested your recipe in test mode before starting, the recipe will not reprocess any trigger events previously picked up during testing. This prevents duplication of data in your apps. You should only start your recipe when you've fully tested it - check out the section on testing recipes if not.

If you have any successful jobs, the start button should be displayed by default. Otherwise, it can be found in the dropdown list.

Default start button Start button showing up on default for a recipe with at least 1 successful job

# Starting a recipe for the second time

For most Workato recipes, when a recipe is started after it has been stopped previously, it will continue where it was stopped. For example, if it was stopped on Monday, and started again from Thursday, the recipe will fetch all trigger events since Monday and process them.

However, this might not be the case for recipes with real-time triggers powered by webhooks - trigger events that occur during the time that the recipe was stopped might not be picked up by the recipe. You can read more about real-time triggers and webhooks here.

# Stop recipe

Stopping a recipe makes it inactive. It will stop picking up trigger events. Recipes have to be stopped to make changes to the recipe, or to rename the recipe.

Most Workato recipes will continue where they have left off when a recipe is restarted from a stopped state. This depends on the trigger it has. For most Workato triggers, the recipe will continue to process jobs from when it stopped - for example, if it was stopped on Monday, and started again from Thursday, the recipe will fetch all trigger events since Monday and process them.

However, this might not be the case for recipes with real-time triggers powered by webhooks - trigger events that occur during the time that the recipe was stopped might not be picked up by the recipe. You can read more about real-time triggers and webhooks here.

# Recipes stopped by Workato

Some recipes are stopped by Workato. In such cases, you will receive an email from us about this stopped recipe. There are 2 reasons for this:

  1. Recipes are automatically stopped when the monthly transaction limit is hit. Contact our customer success team to add more transactions.

  2. The recipe has experienced 60 consecutive errors when trying to fetch trigger events. This can be due to various causes, for example, password change leading to disconnected connection, API server of the app was down, etc. You have to fix the underlying issue before the recipe will work.

consecerror Error message shown in the recipe when there has been 60 consecutive trigger errors

# Notifications email

When a recipe is stopped by Workato, an email is sent to the login email associated with the Workato account. This email can be changed, and additional recipients can also be added to be notified via the Notifications email setup in your account settings.

notemail Configure the emails to notify in account settings