Scheduling

Scheduling Automated Tests

Vaktum allows you to schedule regular test runs to continuously monitor your API's health and performance over time.

Benefits of Scheduled Testing

• Early Detection: Catch API regressions and issues before they impact users
• Continuous Validation: Ensure your API remains functional as dependencies evolve
• Performance Tracking: Monitor response times and detect performance degradation
• SLA Compliance: Verify that your API meets service level agreements
• Documentation Accuracy: Ensure your API behaves as documented

Creating Test Schedules

Via Vaktum.com

1. Navigate to the Scheduler section of Vaktum.com
2. Click "Create Schedule"
3. Configure your schedule:
   • Test Suite: Select the test suite to run
   • Environment: Choose the target environment
   • Frequency: Set how often to run tests (hourly, daily, weekly, custom)
   • Start Time: Define when the schedule should begin
   • Notifications: Configure who should be notified of results
4. Click "Save" to activate the schedule

Via Vaktum API

Create schedules programmatically using the Vaktum API:

curl -X POST "https://api.vaktum.com/v1/schedules" \
  -H "X-API-KEY: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Daily Production Test",
    "testSuiteId": "your-test-suite-id",
    "environmentId": "your-environment-id",
    "cronExpression": "0 0 * * *",
    "notificationSettings": {
      "onFailure": true,
      "onSuccess": false
    }
  }'

Schedule Types

Vaktum supports various scheduling options:

• Simple Schedules: Run tests at regular intervals (hourly, daily, weekly)
• Cron Expressions: Use cron syntax for more complex scheduling needs
• One-time Schedules: Execute tests once at a specified time
• Event-based Triggers: Run tests in response to external events (webhooks)

Managing Schedules

From the Schedules dashboard, you can:

• View Schedule History: See past executions and their results
• Pause/Resume Schedules: Temporarily disable or re-enable schedules
• Edit Schedules: Modify frequency, test suite, or other parameters
• Delete Schedules: Remove schedules that are no longer needed

Schedule Execution Details

For each scheduled execution, Vaktum records:

• Start and End Time: When the test run began and completed
• Duration: Total execution time
• Result Summary: Pass/fail statistics
• Error Details: Information about any failures
• Performance Metrics: Response time data

Schedule-specific Settings

Advanced options for scheduled test runs include:

• Timeout: Maximum time a scheduled run can execute before being terminated
• Retry Logic: Automatically retry failed tests
• Concurrency: Number of tests to run in parallel
• Priority: Set the execution priority relative to other scheduled runs

Notifications for Scheduled Runs

Configure notifications to alert your team about scheduled test results:

• Email Notifications: Send results to specified email addresses
• Slack Integration: Post results to Slack channels
• Webhook Callbacks: Trigger custom workflows based on test results
• Status Page Updates: Automatically update your API status page

For more information on notification options, see the Notifications section.