Execute Workflow
curl --request POST \
--url https://api.example.com/v1/workflows/{workflow_uuid}/execute \
--header 'Content-Type: application/json' \
--data '
{
"indicator_type": "<string>",
"indicator_value": "<string>",
"alert_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "<string>",
"confidence": 0.5
}
'import requests
url = "https://api.example.com/v1/workflows/{workflow_uuid}/execute"
payload = {
"indicator_type": "<string>",
"indicator_value": "<string>",
"alert_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "<string>",
"confidence": 0.5
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
indicator_type: '<string>',
indicator_value: '<string>',
alert_uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
reason: '<string>',
confidence: 0.5
})
};
fetch('https://api.example.com/v1/workflows/{workflow_uuid}/execute', 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/v1/workflows/{workflow_uuid}/execute",
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([
'indicator_type' => '<string>',
'indicator_value' => '<string>',
'alert_uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'reason' => '<string>',
'confidence' => 0.5
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v1/workflows/{workflow_uuid}/execute"
payload := strings.NewReader("{\n \"indicator_type\": \"<string>\",\n \"indicator_value\": \"<string>\",\n \"alert_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reason\": \"<string>\",\n \"confidence\": 0.5\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/v1/workflows/{workflow_uuid}/execute")
.header("Content-Type", "application/json")
.body("{\n \"indicator_type\": \"<string>\",\n \"indicator_value\": \"<string>\",\n \"alert_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reason\": \"<string>\",\n \"confidence\": 0.5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workflows/{workflow_uuid}/execute")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"indicator_type\": \"<string>\",\n \"indicator_value\": \"<string>\",\n \"alert_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reason\": \"<string>\",\n \"confidence\": 0.5\n}"
response = http.request(request)
puts response.read_body{
"data": {
"run_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>"
},
"meta": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Workflows
Execute Workflow
Enqueue a workflow for execution. Returns 202 Accepted immediately.
The trigger source is derived from the API key's `key_type` field —
agent keys always trigger as "agent", human keys as "human". This
cannot be overridden by the request body.
Approval gate (based on workflow.approval_mode):
- If approval_mode="always": all triggers go through approval gate.
- If approval_mode="agent_only": only agent triggers require approval.
- If approval_mode="never": no approval required, immediate execution.
When the approval gate fires, creates an approval request, enqueues a
notification, and returns:
{"status": "pending_approval", "approval_request_uuid": "...", "expires_at": "..."}
When key_type="agent", both `reason` and `confidence` are required.
POST
/
v1
/
workflows
/
{workflow_uuid}
/
execute
Execute Workflow
curl --request POST \
--url https://api.example.com/v1/workflows/{workflow_uuid}/execute \
--header 'Content-Type: application/json' \
--data '
{
"indicator_type": "<string>",
"indicator_value": "<string>",
"alert_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "<string>",
"confidence": 0.5
}
'import requests
url = "https://api.example.com/v1/workflows/{workflow_uuid}/execute"
payload = {
"indicator_type": "<string>",
"indicator_value": "<string>",
"alert_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "<string>",
"confidence": 0.5
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
indicator_type: '<string>',
indicator_value: '<string>',
alert_uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
reason: '<string>',
confidence: 0.5
})
};
fetch('https://api.example.com/v1/workflows/{workflow_uuid}/execute', 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/v1/workflows/{workflow_uuid}/execute",
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([
'indicator_type' => '<string>',
'indicator_value' => '<string>',
'alert_uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'reason' => '<string>',
'confidence' => 0.5
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v1/workflows/{workflow_uuid}/execute"
payload := strings.NewReader("{\n \"indicator_type\": \"<string>\",\n \"indicator_value\": \"<string>\",\n \"alert_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reason\": \"<string>\",\n \"confidence\": 0.5\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/v1/workflows/{workflow_uuid}/execute")
.header("Content-Type", "application/json")
.body("{\n \"indicator_type\": \"<string>\",\n \"indicator_value\": \"<string>\",\n \"alert_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reason\": \"<string>\",\n \"confidence\": 0.5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workflows/{workflow_uuid}/execute")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"indicator_type\": \"<string>\",\n \"indicator_value\": \"<string>\",\n \"alert_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"reason\": \"<string>\",\n \"confidence\": 0.5\n}"
response = http.request(request)
puts response.read_body{
"data": {
"run_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>"
},
"meta": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Path Parameters
Body
application/json
Request body for POST /v1/workflows/{uuid}/execute.
The trigger source is NOT a request field — it is derived server-side
from the API key's key_type (human or agent). Agent keys
must also provide reason and confidence for the approval gate.
⌘I

