Skip to main content
POST
/
v1
/
workflows
Create Workflow
curl --request POST \
  --url https://api.example.com/v1/workflows \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "code": "<string>",
  "workflow_type": "<string>",
  "indicator_types": [],
  "state": "draft",
  "timeout_seconds": 300,
  "retry_count": 0,
  "is_active": true,
  "tags": [],
  "time_saved_minutes": 123,
  "approval_mode": "always",
  "approval_channel": "<string>",
  "approval_timeout_seconds": 3600,
  "risk_level": "medium",
  "documentation": "<string>"
}
'
import requests

url = "https://api.example.com/v1/workflows"

payload = {
"name": "<string>",
"code": "<string>",
"workflow_type": "<string>",
"indicator_types": [],
"state": "draft",
"timeout_seconds": 300,
"retry_count": 0,
"is_active": True,
"tags": [],
"time_saved_minutes": 123,
"approval_mode": "always",
"approval_channel": "<string>",
"approval_timeout_seconds": 3600,
"risk_level": "medium",
"documentation": "<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({
name: '<string>',
code: '<string>',
workflow_type: '<string>',
indicator_types: [],
state: 'draft',
timeout_seconds: 300,
retry_count: 0,
is_active: true,
tags: [],
time_saved_minutes: 123,
approval_mode: 'always',
approval_channel: '<string>',
approval_timeout_seconds: 3600,
risk_level: 'medium',
documentation: '<string>'
})
};

fetch('https://api.example.com/v1/workflows', 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",
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([
'name' => '<string>',
'code' => '<string>',
'workflow_type' => '<string>',
'indicator_types' => [

],
'state' => 'draft',
'timeout_seconds' => 300,
'retry_count' => 0,
'is_active' => true,
'tags' => [

],
'time_saved_minutes' => 123,
'approval_mode' => 'always',
'approval_channel' => '<string>',
'approval_timeout_seconds' => 3600,
'risk_level' => 'medium',
'documentation' => '<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.example.com/v1/workflows"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"workflow_type\": \"<string>\",\n \"indicator_types\": [],\n \"state\": \"draft\",\n \"timeout_seconds\": 300,\n \"retry_count\": 0,\n \"is_active\": true,\n \"tags\": [],\n \"time_saved_minutes\": 123,\n \"approval_mode\": \"always\",\n \"approval_channel\": \"<string>\",\n \"approval_timeout_seconds\": 3600,\n \"risk_level\": \"medium\",\n \"documentation\": \"<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.example.com/v1/workflows")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"workflow_type\": \"<string>\",\n \"indicator_types\": [],\n \"state\": \"draft\",\n \"timeout_seconds\": 300,\n \"retry_count\": 0,\n \"is_active\": true,\n \"tags\": [],\n \"time_saved_minutes\": 123,\n \"approval_mode\": \"always\",\n \"approval_channel\": \"<string>\",\n \"approval_timeout_seconds\": 3600,\n \"risk_level\": \"medium\",\n \"documentation\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/workflows")

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 \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"workflow_type\": \"<string>\",\n \"indicator_types\": [],\n \"state\": \"draft\",\n \"timeout_seconds\": 300,\n \"retry_count\": 0,\n \"is_active\": true,\n \"tags\": [],\n \"time_saved_minutes\": 123,\n \"approval_mode\": \"always\",\n \"approval_channel\": \"<string>\",\n \"approval_timeout_seconds\": 3600,\n \"risk_level\": \"medium\",\n \"documentation\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "workflow_type": "<string>",
    "indicator_types": [
      "<string>"
    ],
    "state": "<string>",
    "code_version": 123,
    "is_active": true,
    "is_system": true,
    "tags": [
      "<string>"
    ],
    "time_saved_minutes": 123,
    "approval_mode": "<string>",
    "risk_level": "<string>",
    "documentation": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "code": "<string>",
    "timeout_seconds": 123,
    "retry_count": 123,
    "approval_channel": "<string>",
    "approval_timeout_seconds": 123
  },
  "meta": {}
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Body

application/json

Request body for POST /v1/workflows.

name
string
required
code
string
required
workflow_type
string | null
indicator_types
string[]
state
string
default:draft
timeout_seconds
integer
default:300
retry_count
integer
default:0
is_active
boolean
default:true
tags
string[]
time_saved_minutes
integer | null
approval_mode
string
default:always
approval_channel
string | null
approval_timeout_seconds
integer
default:3600
risk_level
string
default:medium
documentation
string | null

Response

Successful Response

data
WorkflowResponse · object
required

Full response — includes code and approval config.

meta
Meta · object