curl --request POST \
--url https://your-instance.example.com/api/workflows/{id}/execute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactId": "64b2c3d4e5f60012345678aa",
"conversationId": "64d2f9c5e8a1d4e001a0b1c2"
}
'import requests
url = "https://your-instance.example.com/api/workflows/{id}/execute"
payload = {
"contactId": "64b2c3d4e5f60012345678aa",
"conversationId": "64d2f9c5e8a1d4e001a0b1c2"
}
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({
contactId: '64b2c3d4e5f60012345678aa',
conversationId: '64d2f9c5e8a1d4e001a0b1c2'
})
};
fetch('https://your-instance.example.com/api/workflows/{id}/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://your-instance.example.com/api/workflows/{id}/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([
'contactId' => '64b2c3d4e5f60012345678aa',
'conversationId' => '64d2f9c5e8a1d4e001a0b1c2'
]),
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://your-instance.example.com/api/workflows/{id}/execute"
payload := strings.NewReader("{\n \"contactId\": \"64b2c3d4e5f60012345678aa\",\n \"conversationId\": \"64d2f9c5e8a1d4e001a0b1c2\"\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://your-instance.example.com/api/workflows/{id}/execute")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"64b2c3d4e5f60012345678aa\",\n \"conversationId\": \"64d2f9c5e8a1d4e001a0b1c2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/workflows/{id}/execute")
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 \"contactId\": \"64b2c3d4e5f60012345678aa\",\n \"conversationId\": \"64d2f9c5e8a1d4e001a0b1c2\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Workflow execution queued",
"queued": true
}{
"success": false,
"message": "Workflow not found"
}Manually execute a workflow
Runs a workflow synchronously through the workflow engine for testing or one-off use. Optional contactId/conversationId scope the run; the response includes the WorkflowExecution record plus a summary of nodes executed and duration.
curl --request POST \
--url https://your-instance.example.com/api/workflows/{id}/execute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactId": "64b2c3d4e5f60012345678aa",
"conversationId": "64d2f9c5e8a1d4e001a0b1c2"
}
'import requests
url = "https://your-instance.example.com/api/workflows/{id}/execute"
payload = {
"contactId": "64b2c3d4e5f60012345678aa",
"conversationId": "64d2f9c5e8a1d4e001a0b1c2"
}
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({
contactId: '64b2c3d4e5f60012345678aa',
conversationId: '64d2f9c5e8a1d4e001a0b1c2'
})
};
fetch('https://your-instance.example.com/api/workflows/{id}/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://your-instance.example.com/api/workflows/{id}/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([
'contactId' => '64b2c3d4e5f60012345678aa',
'conversationId' => '64d2f9c5e8a1d4e001a0b1c2'
]),
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://your-instance.example.com/api/workflows/{id}/execute"
payload := strings.NewReader("{\n \"contactId\": \"64b2c3d4e5f60012345678aa\",\n \"conversationId\": \"64d2f9c5e8a1d4e001a0b1c2\"\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://your-instance.example.com/api/workflows/{id}/execute")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"64b2c3d4e5f60012345678aa\",\n \"conversationId\": \"64d2f9c5e8a1d4e001a0b1c2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/workflows/{id}/execute")
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 \"contactId\": \"64b2c3d4e5f60012345678aa\",\n \"conversationId\": \"64d2f9c5e8a1d4e001a0b1c2\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Workflow execution queued",
"queued": true
}{
"success": false,
"message": "Workflow not found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Optional scoping for a manual run. Forwarded to the queued job as trigger.contactId / trigger.conversationId so workflow nodes can reference an existing contact/conversation.
Response
Workflow execution queued (runs asynchronously on the workflow-runner service)
Returned by POST /api/workflows/{id}/execute. The handler enqueues a BullMQ job; actual execution happens asynchronously on the workflow-runner service. Inspect the WorkflowExecution collection by workflowId to follow the run.