Scheduled tasks

You can set up "Scheduled Tasks" to automatically run configured automated test scenarios at specified times, obtain task execution results, and meet the requirements for scheduled testing and regression.

:::tip[]

• Scheduled tasks is in Beta right now.
• To run scheduled tasks, you first need to configure a self-hosted Runner.
• The number of times you can run scheduled tasks depends on the plan you have subscribed to. You can find the details on the Apidog pricing page.
  :::

Accessing the scheduled tasks list

To access the "Scheduled Tasks" list, navigate to the Tests module and click on "Scheduled Tasks." Here, you can view and manage all scheduled tasks for the current project. The list includes important information such as:

• Number of Executions: The total number of times this scheduled task has been executed.
• Enable: Tasks are enabled by default. If disabled, the task will no longer execute automatically.
• Next Run Time: The next scheduled execution time, based on the configured schedule.

Creating a new scheduled task

When creating a new scheduled task, you need to set the following information:

• Task Name and Description: Used to distinguish scheduled tasks and explain the detailed purpose of the task.
• Test Scenario: The scheduled task will execute one or more selected test scenarios. Each scenario can have its own execution settings.
• Run Mode: Set the timing cycle for executing this scheduled task, such as every Sunday at 11 PM, or every 6 hours.
• Runs On: Specify the instance that will execute this scheduled task. It can be executed through Apidog Cloud (coming soon) or via a self-hosted Runner. If the team has deployed multiple general-purpose Runners, you can choose one of them.
• Notification: Enable notifications to send execution results to relevant people via specified channels. For emails, project members' addresses are auto-completed, but you can also enter addresses of non-project members.

Executing scheduled tasks

Once a scheduled task is completed, notifications will be sent to relevant personnel through the specified channels, and the execution results will be saved on the task's execution results page. You can check the "Run History" page for detailed information on the scheduled tasks.