Create a new workflow
curl --request POST \
--url https://your-instance.example.com/api/workflows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "New Lead Welcome",
"description": "Greet new leads and assign them to a leasing agent.",
"nodes": [
{
"id": "n1",
"type": "trigger",
"position": {
"x": 50,
"y": 50
},
"data": {
"event": "application.created"
}
},
{
"id": "n2",
"type": "sendMessage",
"position": {
"x": 250,
"y": 50
},
"data": {
"template": "welcome-sms"
}
}
],
"edges": [
{
"id": "e1",
"source": "n1",
"target": "n2"
}
],
"viewport": {
"x": 0,
"y": 0,
"zoom": 1
},
"enabled": true
}
'import requests
url = "https://your-instance.example.com/api/workflows"
payload = {
"name": "New Lead Welcome",
"description": "Greet new leads and assign them to a leasing agent.",
"nodes": [
{
"id": "n1",
"type": "trigger",
"position": {
"x": 50,
"y": 50
},
"data": { "event": "application.created" }
},
{
"id": "n2",
"type": "sendMessage",
"position": {
"x": 250,
"y": 50
},
"data": { "template": "welcome-sms" }
}
],
"edges": [
{
"id": "e1",
"source": "n1",
"target": "n2"
}
],
"viewport": {
"x": 0,
"y": 0,
"zoom": 1
},
"enabled": True
}
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({
name: 'New Lead Welcome',
description: 'Greet new leads and assign them to a leasing agent.',
nodes: [
{
id: 'n1',
type: 'trigger',
position: {x: 50, y: 50},
data: {event: 'application.created'}
},
{
id: 'n2',
type: 'sendMessage',
position: {x: 250, y: 50},
data: {template: 'welcome-sms'}
}
],
edges: [{id: 'e1', source: 'n1', target: 'n2'}],
viewport: {x: 0, y: 0, zoom: 1},
enabled: true
})
};
fetch('https://your-instance.example.com/api/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://your-instance.example.com/api/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' => 'New Lead Welcome',
'description' => 'Greet new leads and assign them to a leasing agent.',
'nodes' => [
[
'id' => 'n1',
'type' => 'trigger',
'position' => [
'x' => 50,
'y' => 50
],
'data' => [
'event' => 'application.created'
]
],
[
'id' => 'n2',
'type' => 'sendMessage',
'position' => [
'x' => 250,
'y' => 50
],
'data' => [
'template' => 'welcome-sms'
]
]
],
'edges' => [
[
'id' => 'e1',
'source' => 'n1',
'target' => 'n2'
]
],
'viewport' => [
'x' => 0,
'y' => 0,
'zoom' => 1
],
'enabled' => true
]),
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"
payload := strings.NewReader("{\n \"name\": \"New Lead Welcome\",\n \"description\": \"Greet new leads and assign them to a leasing agent.\",\n \"nodes\": [\n {\n \"id\": \"n1\",\n \"type\": \"trigger\",\n \"position\": {\n \"x\": 50,\n \"y\": 50\n },\n \"data\": {\n \"event\": \"application.created\"\n }\n },\n {\n \"id\": \"n2\",\n \"type\": \"sendMessage\",\n \"position\": {\n \"x\": 250,\n \"y\": 50\n },\n \"data\": {\n \"template\": \"welcome-sms\"\n }\n }\n ],\n \"edges\": [\n {\n \"id\": \"e1\",\n \"source\": \"n1\",\n \"target\": \"n2\"\n }\n ],\n \"viewport\": {\n \"x\": 0,\n \"y\": 0,\n \"zoom\": 1\n },\n \"enabled\": true\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"New Lead Welcome\",\n \"description\": \"Greet new leads and assign them to a leasing agent.\",\n \"nodes\": [\n {\n \"id\": \"n1\",\n \"type\": \"trigger\",\n \"position\": {\n \"x\": 50,\n \"y\": 50\n },\n \"data\": {\n \"event\": \"application.created\"\n }\n },\n {\n \"id\": \"n2\",\n \"type\": \"sendMessage\",\n \"position\": {\n \"x\": 250,\n \"y\": 50\n },\n \"data\": {\n \"template\": \"welcome-sms\"\n }\n }\n ],\n \"edges\": [\n {\n \"id\": \"e1\",\n \"source\": \"n1\",\n \"target\": \"n2\"\n }\n ],\n \"viewport\": {\n \"x\": 0,\n \"y\": 0,\n \"zoom\": 1\n },\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/workflows")
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 \"name\": \"New Lead Welcome\",\n \"description\": \"Greet new leads and assign them to a leasing agent.\",\n \"nodes\": [\n {\n \"id\": \"n1\",\n \"type\": \"trigger\",\n \"position\": {\n \"x\": 50,\n \"y\": 50\n },\n \"data\": {\n \"event\": \"application.created\"\n }\n },\n {\n \"id\": \"n2\",\n \"type\": \"sendMessage\",\n \"position\": {\n \"x\": 250,\n \"y\": 50\n },\n \"data\": {\n \"template\": \"welcome-sms\"\n }\n }\n ],\n \"edges\": [\n {\n \"id\": \"e1\",\n \"source\": \"n1\",\n \"target\": \"n2\"\n }\n ],\n \"viewport\": {\n \"x\": 0,\n \"y\": 0,\n \"zoom\": 1\n },\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Workflow created successfully",
"data": {
"_id": "64d2f9c5e8a1d4e001a0b1c2",
"name": "New Lead Welcome",
"description": "Greet new leads and assign them to a leasing agent.",
"organizationId": "64a1b2c3d4e5f60012345678",
"userId": "64a1b2c3d4e5f60012345679",
"nodes": [],
"edges": [],
"viewport": {
"x": 0,
"y": 0,
"zoom": 1
},
"enabled": false,
"createdAt": "2026-04-12T14:22:10.000Z",
"updatedAt": "2026-04-12T14:22:10.000Z"
}
}{
"success": false,
"message": "Workflow not found"
}Workflows
Create a new workflow
Creates a new Workflow owned by the caller user and organization. Stores the visual builder canvas (nodes + edges + viewport) and metadata. Names must be unique within the organization.
POST
/
api
/
workflows
Create a new workflow
curl --request POST \
--url https://your-instance.example.com/api/workflows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "New Lead Welcome",
"description": "Greet new leads and assign them to a leasing agent.",
"nodes": [
{
"id": "n1",
"type": "trigger",
"position": {
"x": 50,
"y": 50
},
"data": {
"event": "application.created"
}
},
{
"id": "n2",
"type": "sendMessage",
"position": {
"x": 250,
"y": 50
},
"data": {
"template": "welcome-sms"
}
}
],
"edges": [
{
"id": "e1",
"source": "n1",
"target": "n2"
}
],
"viewport": {
"x": 0,
"y": 0,
"zoom": 1
},
"enabled": true
}
'import requests
url = "https://your-instance.example.com/api/workflows"
payload = {
"name": "New Lead Welcome",
"description": "Greet new leads and assign them to a leasing agent.",
"nodes": [
{
"id": "n1",
"type": "trigger",
"position": {
"x": 50,
"y": 50
},
"data": { "event": "application.created" }
},
{
"id": "n2",
"type": "sendMessage",
"position": {
"x": 250,
"y": 50
},
"data": { "template": "welcome-sms" }
}
],
"edges": [
{
"id": "e1",
"source": "n1",
"target": "n2"
}
],
"viewport": {
"x": 0,
"y": 0,
"zoom": 1
},
"enabled": True
}
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({
name: 'New Lead Welcome',
description: 'Greet new leads and assign them to a leasing agent.',
nodes: [
{
id: 'n1',
type: 'trigger',
position: {x: 50, y: 50},
data: {event: 'application.created'}
},
{
id: 'n2',
type: 'sendMessage',
position: {x: 250, y: 50},
data: {template: 'welcome-sms'}
}
],
edges: [{id: 'e1', source: 'n1', target: 'n2'}],
viewport: {x: 0, y: 0, zoom: 1},
enabled: true
})
};
fetch('https://your-instance.example.com/api/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://your-instance.example.com/api/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' => 'New Lead Welcome',
'description' => 'Greet new leads and assign them to a leasing agent.',
'nodes' => [
[
'id' => 'n1',
'type' => 'trigger',
'position' => [
'x' => 50,
'y' => 50
],
'data' => [
'event' => 'application.created'
]
],
[
'id' => 'n2',
'type' => 'sendMessage',
'position' => [
'x' => 250,
'y' => 50
],
'data' => [
'template' => 'welcome-sms'
]
]
],
'edges' => [
[
'id' => 'e1',
'source' => 'n1',
'target' => 'n2'
]
],
'viewport' => [
'x' => 0,
'y' => 0,
'zoom' => 1
],
'enabled' => true
]),
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"
payload := strings.NewReader("{\n \"name\": \"New Lead Welcome\",\n \"description\": \"Greet new leads and assign them to a leasing agent.\",\n \"nodes\": [\n {\n \"id\": \"n1\",\n \"type\": \"trigger\",\n \"position\": {\n \"x\": 50,\n \"y\": 50\n },\n \"data\": {\n \"event\": \"application.created\"\n }\n },\n {\n \"id\": \"n2\",\n \"type\": \"sendMessage\",\n \"position\": {\n \"x\": 250,\n \"y\": 50\n },\n \"data\": {\n \"template\": \"welcome-sms\"\n }\n }\n ],\n \"edges\": [\n {\n \"id\": \"e1\",\n \"source\": \"n1\",\n \"target\": \"n2\"\n }\n ],\n \"viewport\": {\n \"x\": 0,\n \"y\": 0,\n \"zoom\": 1\n },\n \"enabled\": true\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"New Lead Welcome\",\n \"description\": \"Greet new leads and assign them to a leasing agent.\",\n \"nodes\": [\n {\n \"id\": \"n1\",\n \"type\": \"trigger\",\n \"position\": {\n \"x\": 50,\n \"y\": 50\n },\n \"data\": {\n \"event\": \"application.created\"\n }\n },\n {\n \"id\": \"n2\",\n \"type\": \"sendMessage\",\n \"position\": {\n \"x\": 250,\n \"y\": 50\n },\n \"data\": {\n \"template\": \"welcome-sms\"\n }\n }\n ],\n \"edges\": [\n {\n \"id\": \"e1\",\n \"source\": \"n1\",\n \"target\": \"n2\"\n }\n ],\n \"viewport\": {\n \"x\": 0,\n \"y\": 0,\n \"zoom\": 1\n },\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/workflows")
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 \"name\": \"New Lead Welcome\",\n \"description\": \"Greet new leads and assign them to a leasing agent.\",\n \"nodes\": [\n {\n \"id\": \"n1\",\n \"type\": \"trigger\",\n \"position\": {\n \"x\": 50,\n \"y\": 50\n },\n \"data\": {\n \"event\": \"application.created\"\n }\n },\n {\n \"id\": \"n2\",\n \"type\": \"sendMessage\",\n \"position\": {\n \"x\": 250,\n \"y\": 50\n },\n \"data\": {\n \"template\": \"welcome-sms\"\n }\n }\n ],\n \"edges\": [\n {\n \"id\": \"e1\",\n \"source\": \"n1\",\n \"target\": \"n2\"\n }\n ],\n \"viewport\": {\n \"x\": 0,\n \"y\": 0,\n \"zoom\": 1\n },\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Workflow created successfully",
"data": {
"_id": "64d2f9c5e8a1d4e001a0b1c2",
"name": "New Lead Welcome",
"description": "Greet new leads and assign them to a leasing agent.",
"organizationId": "64a1b2c3d4e5f60012345678",
"userId": "64a1b2c3d4e5f60012345679",
"nodes": [],
"edges": [],
"viewport": {
"x": 0,
"y": 0,
"zoom": 1
},
"enabled": false,
"createdAt": "2026-04-12T14:22:10.000Z",
"updatedAt": "2026-04-12T14:22:10.000Z"
}
}{
"success": false,
"message": "Workflow not found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Human-readable workflow name. Must be unique within the caller organization.
Free-text description shown in the workflows list and builder header.
Visual builder nodes — each carries id, type, position, and node-specific data.
Directed connections between nodes (source → target ids) defining execution flow.
Camera state for the canvas (x, y, zoom). Defaults to { x: 0, y: 0, zoom: 1 } when omitted.
Show child attributes
Show child attributes
When false, the trigger system skips this workflow even when conditions match. Defaults to false on create.
Response
Workflow created successfully
Returned by create/update/toggle. Wraps the resulting WorkflowDocument plus a status message.
Available options:
true A Workflow document — visual builder canvas (nodes + edges) plus enabled flag and metadata.
Show child attributes
Show child attributes
Example:
{ "_id": "64d2f9c5e8a1d4e001a0b1c2", "name": "New Lead Welcome", "description": "Greet new leads and assign them to a leasing agent.", "organizationId": "64a1b2c3d4e5f60012345678", "userId": "64a1b2c3d4e5f60012345679", "nodes": [ { "id": "n1", "type": "trigger", "position": { "x": 50, "y": 50 }, "data": { "event": "application.created" } }, { "id": "n2", "type": "sendMessage", "position": { "x": 250, "y": 50 }, "data": { "template": "welcome-sms" } } ], "edges": [ { "id": "e1", "source": "n1", "target": "n2" } ], "viewport": { "x": 0, "y": 0, "zoom": 1 }, "enabled": true, "createdAt": "2026-04-12T14:22:10.000Z", "updatedAt": "2026-04-22T10:14:00.000Z" }
⌘I