Testim Documentation

Welcome to the Testim documentation. You'll find comprehensive guides to help you get started quickly, example code snippets, and tips for being more productive. You will also find details about advanced features that allow you to customize Testim to fit your environment or special testing conditions. Don't worry, we'll support you if you get stuck. Let's jump right in!

Guides    Changelog


Schedule your tests and monitor your application

Scheduled runs are test runs that will run based on a predefined schedule. For example, you can schedule tests to run a nightly build or to run every 30 minutes in order to monitor your production app. In order to schedule a test run, the test must have a Label or be part of a Test suite.


If the test includes multiple data sets, the scheduler will run the test multiple times, in order, each time with a different data set. For more information see, Data-driven testing.

Creating a scheduled test run


If you have previously created schedulers and you want the new scheduler to be based on an existing one, you can use the Cloning Scheduler feature.

To create a new test run schedule:

  1. Go to Runs -> Scheduled Runs.
  2. Click Create New or Let's Schedule (when its your first scheduled run).

The Create a new Schedule window opens.

  1. Under General Information, enter a name for the scheduler and optionally a description.
  2. Under What to run, in the Test list filed, start typing and then select the name of the Label and/or Test suite name of the tests that you want to include in the scheduled run. If you don't see a drop-down list, verify the correct spelling of the label/suite.
  3. Under What to run on, select the following:
    • Override default configurations - select this option if you would like to override the current test configurations concerning the browser that the test will run on, screen resolution, OS, and more. After selecting this option, you can select one of the pre-configured configurations, edit a pre-configured configuration, or create a new configuration. For more information, see Test Configuration Parameters.
    • Override base URL - select this option if you would like to override the current test configurations concerning the base URL. After selecting this option, enter the new Base URL .
  4. Under Adjust your time schedule, select one of the following options:
    • Monitor - Will run the tests on a set interval. Use this option to monitor the health of your application and alert when your service is down.
      * Nightly run - Schedule the tests to run on certain days of the week and the time of day. Use this option to automatically trigger test runs such as nightly regression testing.
      By default the run is scheduled to run on every day. You can remove/edit on which days you would like it to run, by clicking the days to select/deselect them.
  5. Under Where to run, select the grid you would like to execute your tests on. For more information about grid configuration, see Grid management.
  6. Under Notifications, select the following:
    • Notify on - By default when creating a new schedule, you are set to be notified on every failure. You can change the notification preference to any of the following options:
  • Preferences - You can specify where the notifications will be sent. To receive email notifications, select the "Email" checkbox and enter the target email/s. To send notifications by Slack, select the "Slack" checkbox.


In order to send notifications to Slack you need to set up the initial integration. For details, see below.

  1. Click Advanced to configure Advanced scheduler options.
  2. Save your scheduler by clicking Create.

A new scheduled test run is created, and is automatically turned on:

Integrating Scheduler with Slack

To integrate scheduler with Slack:

  1. In the Create a new Schedule window > Notification section, click Add to Slack.

You will be redirected to Slack to confirm access. Click Allow:

  1. Add the Slack channels you would like to be notified on.


You can remove/add channels, and disable the Slack notifications at any point. If you would like to select a private Slack channel that was added after you already configured the integration, you will need to disconnect it (via Slack) and then reconnect from the scheduler screen.

Advanced scheduler options

For advanced scheduler options such as executing tests in parallel or on a specific branch, adding result labels or extending the test timeout, click on the Advanced option:

  • Parallel - select the number of test that can run in parallel.


Parallel scheduler runs count towards your parallel limit as set by your plan and can affect CLI jobs if executed at the same time.

  • Branch - if you do not was to run the test on the master branch, select the another branch to run on. See Version control (branches) for more information.
  • Failed test retries - select the number of retries to execute if the test has failed. A failed test will be executed repeatedly until either the test passes or the max number of retries has been reached.
  • Add Result labels - if you have specified result labels, add them into this field. Result Labels allows you to add textual labels to your remote runs. See Result labels for more information.
  • Test timeout (seconds) - select the number of seconds after which the test will be aborted.

Modify your scheduled test suites

Activate or Pause

Toggle to pause or re-activate the scheduled test suites.


Click anywhere of the scheduled test suite to edit it.

Seeing your scheduled test suites results

As all other tests - navigate to the "Runs" tab in the sidebar and open the scheduled test run.

Abort a scheduled run

While the suite is running you are able to stop the run. Navigate to RunsSuite Runs ⇒ Select the test that is running ⇒ Click ABORT SCHEDULED RUN.

Cloning a scheduler

You can clone a schedule, modify it, and save it as a new schedule, thus reducing the effort and possible errors in copying configurations manually.

To clone a scheduler:

  1. On the Schedule List screen, select the scheduler that you wish to clone.
  2. Click the Clone button.
  1. Name the scheduler and click Clone.

You can now edit the new scheduler.

Updated 9 months ago


Schedule your tests and monitor your application

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.