Skip to main content
POST
Create a scheduled test job

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
crontab_expression
string
required

Cron expression controlling when the job runs.

name
string
scenarios
integer[]
tags
string[]
agent
integer
timezone
string
personalities
integer[]
execution_mode
string

Execution mode for the test runs, such as voice, text, or sip.

frequency
integer
run_as_text
boolean
notify_on
enum<string>
Available options:
never,
success,
failure,
both
is_active
boolean

Response

Scheduled test job created.

id
integer
required
name
string
required
agent
integer
required

ID of the test agent the job belongs to.

crontab_expression
string
required

Cron expression controlling when the job runs, in the job's timezone.

is_active
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
timezone
string
scenario_ids
integer[]

Scenario IDs the job executes.

scenarios_data
object[]
personality
integer | null
personalities
integer[]
tags
string[]
frequency
integer
run_as_text
boolean

Whether the job runs scenarios as text chat rather than voice calls.

execution_mode
string

Execution mode for the test runs, such as voice, text, or sip.

notify_on
enum<string>

When the job sends a notification.

Available options:
never,
success,
failure,
both