[Beta] Validate a workflow definition
curl --request POST \
--url http://localhost:8080/workflows/validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workflow_blocks": [
"<unknown>"
],
"trigger_configuration": "<unknown>"
}
'import requests
url = "http://localhost:8080/workflows/validate"
payload = {
"workflow_blocks": ["<unknown>"],
"trigger_configuration": "<unknown>"
}
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({workflow_blocks: ['<unknown>'], trigger_configuration: '<unknown>'})
};
fetch('http://localhost:8080/workflows/validate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/workflows/validate",
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([
'workflow_blocks' => [
'<unknown>'
],
'trigger_configuration' => '<unknown>'
]),
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 := "http://localhost:8080/workflows/validate"
payload := strings.NewReader("{\n \"workflow_blocks\": [\n \"<unknown>\"\n ],\n \"trigger_configuration\": \"<unknown>\"\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("http://localhost:8080/workflows/validate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_blocks\": [\n \"<unknown>\"\n ],\n \"trigger_configuration\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/workflows/validate")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_blocks\": [\n \"<unknown>\"\n ],\n \"trigger_configuration\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"valid": true,
"issues": [
{
"step_id": "<string>",
"message": "<string>",
"severity": "error"
}
],
"action_types_used": [
"<string>"
]
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Workflows (Beta)
[Beta] Validate a workflow definition
[Beta] Validate a workflow definition — Validate workflow blocks without creating a workflow.
POST
/
workflows
/
validate
[Beta] Validate a workflow definition
curl --request POST \
--url http://localhost:8080/workflows/validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workflow_blocks": [
"<unknown>"
],
"trigger_configuration": "<unknown>"
}
'import requests
url = "http://localhost:8080/workflows/validate"
payload = {
"workflow_blocks": ["<unknown>"],
"trigger_configuration": "<unknown>"
}
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({workflow_blocks: ['<unknown>'], trigger_configuration: '<unknown>'})
};
fetch('http://localhost:8080/workflows/validate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/workflows/validate",
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([
'workflow_blocks' => [
'<unknown>'
],
'trigger_configuration' => '<unknown>'
]),
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 := "http://localhost:8080/workflows/validate"
payload := strings.NewReader("{\n \"workflow_blocks\": [\n \"<unknown>\"\n ],\n \"trigger_configuration\": \"<unknown>\"\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("http://localhost:8080/workflows/validate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_blocks\": [\n \"<unknown>\"\n ],\n \"trigger_configuration\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/workflows/validate")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_blocks\": [\n \"<unknown>\"\n ],\n \"trigger_configuration\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"valid": true,
"issues": [
{
"step_id": "<string>",
"message": "<string>",
"severity": "error"
}
],
"action_types_used": [
"<string>"
]
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Trigger type to validate against
Available options:
manual-trigger, ai-trigger, cron-trigger, form-trigger, webhook, contact-created, contact-updated, phone-call-started, phone-call-finished, ticket-created, ticket-reassigned, ticket-resolved, ticket-handoff, pre-ticket-handoff, ticket-tag-added, ticket-inactive, agent-inactive, sequence-completed, csat-score-submit, prohibited-topic-detected, sla-first-reply-breached, sla-next-reply-breached, sla-resolution-breached, voice-call-transferred, pre-voice-call-transfer, pre-phone-call-finished, manual-ticket-trigger, contact-message-received, first-contact-message-received, macro-called, ai-response-completed, agent-availability-changed, agent-avail-in-team-changed, ai-response-requested, ticket-reopened, agent-mentioned, agent-message-posted, ticket-team-changed, session-updated Workflow blocks to validate
Trigger configuration to validate against the trigger's configuration_def. When omitted, the trigger is validated as if unconfigured — triggers with required configuration (e.g. cron-trigger, ai-trigger) will report errors.
Was this page helpful?