Skip to main content
POST
/
schedules
/
{schedule_id}
/
trigger
Trigger Schedule
curl --request POST \
  --url https://api.example.com/schedules/{schedule_id}/trigger \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/schedules/{schedule_id}/trigger"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/schedules/{schedule_id}/trigger', 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.example.com/schedules/{schedule_id}/trigger",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/schedules/{schedule_id}/trigger"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

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.example.com/schedules/{schedule_id}/trigger")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/schedules/{schedule_id}/trigger")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "schedule_id": "<string>",
  "attempt": 123,
  "status": "<string>",
  "triggered_at": 123,
  "completed_at": 123,
  "status_code": 123,
  "run_id": "<string>",
  "session_id": "<string>",
  "error": "<string>",
  "input": {},
  "output": {},
  "requirements": [
    {}
  ],
  "created_at": 123
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

schedule_id
string
required

Response

Successful Response

id
string
required
schedule_id
string
required
attempt
integer
required
status
string
required
triggered_at
integer | null
completed_at
integer | null
status_code
integer | null
run_id
string | null
session_id
string | null
error
string | null
input
Input · object | null
output
Output · object | null
requirements
Requirements · object[] | null
created_at
integer | null