curl --request POST \
--url https://api.kaizenautomation.com/workflows/execute \
--header 'Content-Type: application/json' \
--data '
{
"params": {
"origin": "New York",
"destination": "Los Angeles"
},
"workflowId": "<string>",
"workflowName": "<string>",
"loginId": "<string>",
"name": "User batch execution",
"timeout": 10800,
"useProxy": false,
"startBlockId": "1",
"batchId": "batch_123",
"isTest": false,
"agentConversationThreadId": "<string>"
}
'import requests
url = "https://api.kaizenautomation.com/workflows/execute"
payload = {
"params": {
"origin": "New York",
"destination": "Los Angeles"
},
"workflowId": "<string>",
"workflowName": "<string>",
"loginId": "<string>",
"name": "User batch execution",
"timeout": 10800,
"useProxy": False,
"startBlockId": "1",
"batchId": "batch_123",
"isTest": False,
"agentConversationThreadId": "<string>"
}
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({
params: {origin: 'New York', destination: 'Los Angeles'},
workflowId: '<string>',
workflowName: '<string>',
loginId: '<string>',
name: 'User batch execution',
timeout: 10800,
useProxy: false,
startBlockId: '1',
batchId: 'batch_123',
isTest: false,
agentConversationThreadId: '<string>'
})
};
fetch('https://api.kaizenautomation.com/workflows/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.kaizenautomation.com/workflows/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([
'params' => [
'origin' => 'New York',
'destination' => 'Los Angeles'
],
'workflowId' => '<string>',
'workflowName' => '<string>',
'loginId' => '<string>',
'name' => 'User batch execution',
'timeout' => 10800,
'useProxy' => false,
'startBlockId' => '1',
'batchId' => 'batch_123',
'isTest' => false,
'agentConversationThreadId' => '<string>'
]),
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.kaizenautomation.com/workflows/execute"
payload := strings.NewReader("{\n \"params\": {\n \"origin\": \"New York\",\n \"destination\": \"Los Angeles\"\n },\n \"workflowId\": \"<string>\",\n \"workflowName\": \"<string>\",\n \"loginId\": \"<string>\",\n \"name\": \"User batch execution\",\n \"timeout\": 10800,\n \"useProxy\": false,\n \"startBlockId\": \"1\",\n \"batchId\": \"batch_123\",\n \"isTest\": false,\n \"agentConversationThreadId\": \"<string>\"\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.kaizenautomation.com/workflows/execute")
.header("Content-Type", "application/json")
.body("{\n \"params\": {\n \"origin\": \"New York\",\n \"destination\": \"Los Angeles\"\n },\n \"workflowId\": \"<string>\",\n \"workflowName\": \"<string>\",\n \"loginId\": \"<string>\",\n \"name\": \"User batch execution\",\n \"timeout\": 10800,\n \"useProxy\": false,\n \"startBlockId\": \"1\",\n \"batchId\": \"batch_123\",\n \"isTest\": false,\n \"agentConversationThreadId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kaizenautomation.com/workflows/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 \"params\": {\n \"origin\": \"New York\",\n \"destination\": \"Los Angeles\"\n },\n \"workflowId\": \"<string>\",\n \"workflowName\": \"<string>\",\n \"loginId\": \"<string>\",\n \"name\": \"User batch execution\",\n \"timeout\": 10800,\n \"useProxy\": false,\n \"startBlockId\": \"1\",\n \"batchId\": \"batch_123\",\n \"isTest\": false,\n \"agentConversationThreadId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"executionId": "1",
"status": "Processing",
"message": "Workflow execution started successfully"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Workflow not found or does not belong to this organization"
}Execute a workflow
Executes a workflow with the specified login and parameters
curl --request POST \
--url https://api.kaizenautomation.com/workflows/execute \
--header 'Content-Type: application/json' \
--data '
{
"params": {
"origin": "New York",
"destination": "Los Angeles"
},
"workflowId": "<string>",
"workflowName": "<string>",
"loginId": "<string>",
"name": "User batch execution",
"timeout": 10800,
"useProxy": false,
"startBlockId": "1",
"batchId": "batch_123",
"isTest": false,
"agentConversationThreadId": "<string>"
}
'import requests
url = "https://api.kaizenautomation.com/workflows/execute"
payload = {
"params": {
"origin": "New York",
"destination": "Los Angeles"
},
"workflowId": "<string>",
"workflowName": "<string>",
"loginId": "<string>",
"name": "User batch execution",
"timeout": 10800,
"useProxy": False,
"startBlockId": "1",
"batchId": "batch_123",
"isTest": False,
"agentConversationThreadId": "<string>"
}
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({
params: {origin: 'New York', destination: 'Los Angeles'},
workflowId: '<string>',
workflowName: '<string>',
loginId: '<string>',
name: 'User batch execution',
timeout: 10800,
useProxy: false,
startBlockId: '1',
batchId: 'batch_123',
isTest: false,
agentConversationThreadId: '<string>'
})
};
fetch('https://api.kaizenautomation.com/workflows/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.kaizenautomation.com/workflows/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([
'params' => [
'origin' => 'New York',
'destination' => 'Los Angeles'
],
'workflowId' => '<string>',
'workflowName' => '<string>',
'loginId' => '<string>',
'name' => 'User batch execution',
'timeout' => 10800,
'useProxy' => false,
'startBlockId' => '1',
'batchId' => 'batch_123',
'isTest' => false,
'agentConversationThreadId' => '<string>'
]),
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.kaizenautomation.com/workflows/execute"
payload := strings.NewReader("{\n \"params\": {\n \"origin\": \"New York\",\n \"destination\": \"Los Angeles\"\n },\n \"workflowId\": \"<string>\",\n \"workflowName\": \"<string>\",\n \"loginId\": \"<string>\",\n \"name\": \"User batch execution\",\n \"timeout\": 10800,\n \"useProxy\": false,\n \"startBlockId\": \"1\",\n \"batchId\": \"batch_123\",\n \"isTest\": false,\n \"agentConversationThreadId\": \"<string>\"\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.kaizenautomation.com/workflows/execute")
.header("Content-Type", "application/json")
.body("{\n \"params\": {\n \"origin\": \"New York\",\n \"destination\": \"Los Angeles\"\n },\n \"workflowId\": \"<string>\",\n \"workflowName\": \"<string>\",\n \"loginId\": \"<string>\",\n \"name\": \"User batch execution\",\n \"timeout\": 10800,\n \"useProxy\": false,\n \"startBlockId\": \"1\",\n \"batchId\": \"batch_123\",\n \"isTest\": false,\n \"agentConversationThreadId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kaizenautomation.com/workflows/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 \"params\": {\n \"origin\": \"New York\",\n \"destination\": \"Los Angeles\"\n },\n \"workflowId\": \"<string>\",\n \"workflowName\": \"<string>\",\n \"loginId\": \"<string>\",\n \"name\": \"User batch execution\",\n \"timeout\": 10800,\n \"useProxy\": false,\n \"startBlockId\": \"1\",\n \"batchId\": \"batch_123\",\n \"isTest\": false,\n \"agentConversationThreadId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"executionId": "1",
"status": "Processing",
"message": "Workflow execution started successfully"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Workflow not found or does not belong to this organization"
}Body
Runtime parameters for the workflow execution
Show child attributes
Show child attributes
{
"origin": "New York",
"destination": "Los Angeles"
}
ID of the workflow to execute. Either workflowId or workflowName must be provided.
Name of the workflow to execute. If provided, the workflow will be looked up by name within the organization. Either workflowId or workflowName must be provided.
ID of the login to use for authentication
Optional name for the execution (string or number, automatically converted to string)
"User batch execution"
Optional timeout in seconds for the execution (defaults to 10800 seconds / 3 hours)
10800
Whether to use a proxy for this execution
Optional ID of the block to start execution from
"1"
Optional ID of the execution batch to assign this execution to
"batch_123"
Whether this execution is a test run
Optional ID of an agent conversation thread to associate with this execution (used when duplicating executions that were triggered by an agent)