Create schedule
curl --request POST \
--url https://api.veryfront.com/projects/{project_reference}/schedules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"target": {
"id": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"schedule": "<string>",
"timezone": "<string>",
"runtime_target_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"runtime_target_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {},
"timeout_seconds": 123,
"backoff_limit": 1,
"max_runs": 123,
"source_trigger_id": "<string>",
"source_path": "<string>",
"source_hash": "<string>"
}
'import requests
url = "https://api.veryfront.com/projects/{project_reference}/schedules"
payload = {
"name": "<string>",
"target": {
"id": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"schedule": "<string>",
"timezone": "<string>",
"runtime_target_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"runtime_target_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {},
"timeout_seconds": 123,
"backoff_limit": 1,
"max_runs": 123,
"source_trigger_id": "<string>",
"source_path": "<string>",
"source_hash": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
target: {id: '<string>', conversation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
schedule: '<string>',
timezone: '<string>',
runtime_target_environment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
runtime_target_branch_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
config: {},
timeout_seconds: 123,
backoff_limit: 1,
max_runs: 123,
source_trigger_id: '<string>',
source_path: '<string>',
source_hash: '<string>'
})
};
fetch('https://api.veryfront.com/projects/{project_reference}/schedules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.veryfront.com/projects/{project_reference}/schedules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'target' => [
'id' => '<string>',
'conversation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'schedule' => '<string>',
'timezone' => '<string>',
'runtime_target_environment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'runtime_target_branch_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'config' => [
],
'timeout_seconds' => 123,
'backoff_limit' => 1,
'max_runs' => 123,
'source_trigger_id' => '<string>',
'source_path' => '<string>',
'source_hash' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.veryfront.com/projects/{project_reference}/schedules"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"target\": {\n \"id\": \"<string>\",\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"schedule\": \"<string>\",\n \"timezone\": \"<string>\",\n \"runtime_target_environment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"runtime_target_branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {},\n \"timeout_seconds\": 123,\n \"backoff_limit\": 1,\n \"max_runs\": 123,\n \"source_trigger_id\": \"<string>\",\n \"source_path\": \"<string>\",\n \"source_hash\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.veryfront.com/projects/{project_reference}/schedules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"target\": {\n \"id\": \"<string>\",\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"schedule\": \"<string>\",\n \"timezone\": \"<string>\",\n \"runtime_target_environment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"runtime_target_branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {},\n \"timeout_seconds\": 123,\n \"backoff_limit\": 1,\n \"max_runs\": 123,\n \"source_trigger_id\": \"<string>\",\n \"source_path\": \"<string>\",\n \"source_hash\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.veryfront.com/projects/{project_reference}/schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"target\": {\n \"id\": \"<string>\",\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"schedule\": \"<string>\",\n \"timezone\": \"<string>\",\n \"runtime_target_environment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"runtime_target_branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {},\n \"timeout_seconds\": 123,\n \"backoff_limit\": 1,\n \"max_runs\": 123,\n \"source_trigger_id\": \"<string>\",\n \"source_path\": \"<string>\",\n \"source_hash\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"schedule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "active",
"target": {
"kind": "task",
"id": "<string>",
"conversation_mode": "create_new",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"schedule": "<string>",
"timezone": "<string>",
"runtime_target_kind": "main_branch",
"runtime_target_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"runtime_target_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {},
"timeout_seconds": 123,
"backoff_limit": 123,
"concurrency_policy": "<string>",
"definition_source": "manual",
"source_trigger_id": "<string>",
"source_path": "<string>",
"source_hash": "<string>",
"last_scheduled_at": "<string>",
"last_successful_at": "<string>",
"health": {
"maxStalenessSeconds": 123
},
"max_runs": 123,
"run_count": 1,
"completed_at": "<string>",
"paused_reason": "<string>",
"paused_at": "<string>",
"last_failure_at": "<string>",
"last_failure_code": "<string>",
"last_failure_message": "<string>",
"last_failure_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "<string>",
"updated_at": "<string>",
"integration_requirements": []
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error": "<string>",
"message": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error": "<string>",
"message": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error": "<string>",
"message": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error": "<string>",
"message": "<string>"
}Create schedule
Create a recurring schedule that starts a task, a workflow or an agent on a cron expression, or, on REST and GraphQL only, activate a schedule declared in source (the MCP tool creates manual schedules only); returns the schedule: a new schedule is active, and a source schedule that was activated before keeps its current status. Requires project.runs.write.
POST
/
projects
/
{project_reference}
/
schedules
Create schedule
curl --request POST \
--url https://api.veryfront.com/projects/{project_reference}/schedules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"target": {
"id": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"schedule": "<string>",
"timezone": "<string>",
"runtime_target_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"runtime_target_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {},
"timeout_seconds": 123,
"backoff_limit": 1,
"max_runs": 123,
"source_trigger_id": "<string>",
"source_path": "<string>",
"source_hash": "<string>"
}
'import requests
url = "https://api.veryfront.com/projects/{project_reference}/schedules"
payload = {
"name": "<string>",
"target": {
"id": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"schedule": "<string>",
"timezone": "<string>",
"runtime_target_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"runtime_target_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {},
"timeout_seconds": 123,
"backoff_limit": 1,
"max_runs": 123,
"source_trigger_id": "<string>",
"source_path": "<string>",
"source_hash": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
target: {id: '<string>', conversation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
schedule: '<string>',
timezone: '<string>',
runtime_target_environment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
runtime_target_branch_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
config: {},
timeout_seconds: 123,
backoff_limit: 1,
max_runs: 123,
source_trigger_id: '<string>',
source_path: '<string>',
source_hash: '<string>'
})
};
fetch('https://api.veryfront.com/projects/{project_reference}/schedules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.veryfront.com/projects/{project_reference}/schedules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'target' => [
'id' => '<string>',
'conversation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'schedule' => '<string>',
'timezone' => '<string>',
'runtime_target_environment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'runtime_target_branch_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'config' => [
],
'timeout_seconds' => 123,
'backoff_limit' => 1,
'max_runs' => 123,
'source_trigger_id' => '<string>',
'source_path' => '<string>',
'source_hash' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.veryfront.com/projects/{project_reference}/schedules"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"target\": {\n \"id\": \"<string>\",\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"schedule\": \"<string>\",\n \"timezone\": \"<string>\",\n \"runtime_target_environment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"runtime_target_branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {},\n \"timeout_seconds\": 123,\n \"backoff_limit\": 1,\n \"max_runs\": 123,\n \"source_trigger_id\": \"<string>\",\n \"source_path\": \"<string>\",\n \"source_hash\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.veryfront.com/projects/{project_reference}/schedules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"target\": {\n \"id\": \"<string>\",\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"schedule\": \"<string>\",\n \"timezone\": \"<string>\",\n \"runtime_target_environment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"runtime_target_branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {},\n \"timeout_seconds\": 123,\n \"backoff_limit\": 1,\n \"max_runs\": 123,\n \"source_trigger_id\": \"<string>\",\n \"source_path\": \"<string>\",\n \"source_hash\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.veryfront.com/projects/{project_reference}/schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"target\": {\n \"id\": \"<string>\",\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"schedule\": \"<string>\",\n \"timezone\": \"<string>\",\n \"runtime_target_environment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"runtime_target_branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"config\": {},\n \"timeout_seconds\": 123,\n \"backoff_limit\": 1,\n \"max_runs\": 123,\n \"source_trigger_id\": \"<string>\",\n \"source_path\": \"<string>\",\n \"source_hash\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"schedule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "active",
"target": {
"kind": "task",
"id": "<string>",
"conversation_mode": "create_new",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"schedule": "<string>",
"timezone": "<string>",
"runtime_target_kind": "main_branch",
"runtime_target_environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"runtime_target_branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config": {},
"timeout_seconds": 123,
"backoff_limit": 123,
"concurrency_policy": "<string>",
"definition_source": "manual",
"source_trigger_id": "<string>",
"source_path": "<string>",
"source_hash": "<string>",
"last_scheduled_at": "<string>",
"last_successful_at": "<string>",
"health": {
"maxStalenessSeconds": 123
},
"max_runs": 123,
"run_count": 1,
"completed_at": "<string>",
"paused_reason": "<string>",
"paused_at": "<string>",
"last_failure_at": "<string>",
"last_failure_code": "<string>",
"last_failure_message": "<string>",
"last_failure_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "<string>",
"updated_at": "<string>",
"integration_requirements": []
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error": "<string>",
"message": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error": "<string>",
"message": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error": "<string>",
"message": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error": "<string>",
"message": "<string>"
}Authorizations
bearerAuthapiKeyAuth
Use a JWT bearer token or a Veryfront API key in the Authorization header.
Path Parameters
Minimum string length:
1Body
application/json
Required string length:
1 - 255Show child attributes
Show child attributes
Required string length:
1 - 255Required string length:
1 - 128Available options:
main_branch, environment, preview_branch Show child attributes
Show child attributes
Required range:
x >= 0Available options:
Allow, Forbid, Replace Available options:
manual, source Trigger id from the source definition. When a schedule with this id already exists, creating it from source can return that schedule with its current status; a paused schedule remains paused.
Required string length:
1 - 255Required string length:
1 - 1024Required string length:
1 - 255Response
Created an active recurring project schedule for a task, workflow, or agent target.
The created schedule. New schedules are active by default.
Show child attributes
Show child attributes