Languages: every operation supports cURL, Node.js (TypeScript), Python, Go, Ruby, and PHP. The first 15 operations on this page show all six languages; the remaining 7 show cURL and TypeScript — the two most-used.

Flows API

Flows endpoints exposed by the Devotel CPaaS API Base path: /api/v1/flows Endpoint count: 22

Worked flows samples

The endpoint list below documents each operation’s parameters; this overlay walks the chain a runner actually executes, in order, with the exact envelopes you branch on: create the draft → publish → execute → poll the execution → inspect node results, plus the two error shapes to handle. Every request uses your API key (X-API-Key) against https://api.orbit.devotel.io. Links on this page are relative to it; the examples below tab cURL and Node.js (TypeScript). See the recipes guide for templated use cases — welcome series, appointment reminders, support triage, surveys, and order updates with copy-ready definitions. This overlay stays at envelope level: what you send per operation, and what comes back.

1. Create the flow draft

POST /api/v1/flows creates the flow as a draft at version: 1. The definition graph carries nodes (each with an id and type) and edges (source → target between node ids). trigger_type is one of manual, webhook, schedule, event, or workflow; a schedule trigger also needs a 5-field cron_expr and optionally an IANA cron_tz (UTC otherwise) — a missing or unparseable expression is rejected with a 422 (see Errors).

curl -X POST "https://api.orbit.devotel.io/api/v1/flows" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekly re-engagement",
    "description": "Message opted-in customers who went quiet this week.",
    "definition": {
      "nodes": [
        { "id": "trigger_1", "type": "trigger" },
        { "id": "sms_1", "type": "send_sms", "config": { "message": "Still interested? Reply YES." } }
      ],
      "edges": [
        { "source": "trigger_1", "target": "sms_1" }
      ]
    },
    "trigger_type": "schedule",
    "cron_expr": "0 9 * * 1",
    "cron_tz": "America/New_York"
  }'

const res = await fetch("https://api.orbit.devotel.io/api/v1/flows", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.ORBIT_API_KEY!,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Weekly re-engagement",
    description: "Message opted-in customers who went quiet this week.",
    definition: {
      nodes: [
        { id: "trigger_1", type: "trigger" },
        { id: "sms_1", type: "send_sms", config: { message: "Still interested? Reply YES." } },
      ],
      edges: [{ source: "trigger_1", target: "sms_1" }],
    },
    trigger_type: "schedule",
    cron_expr: "0 9 * * 1",
    cron_tz: "America/New_York",
  }),
});
console.log(await res.json());

201

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "draft",
    "version": 1,
    "trigger_type": "schedule",
    "cron_expr": "0 9 * * 1",
    "cron_tz": "America/New_York"
  },
  "meta": {
    "request_id": "req_flow_create",
    "timestamp": "2026-08-27T12:00:00Z"
  }
}

Nothing runs while the flow is a draft. Publishing freezes the current definition as an immutable version and returns the flow with its new status and version:

curl -X POST "https://api.orbit.devotel.io/api/v1/flows/flow_9c3f1a8e/publish" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

200

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

2. Execute and poll

POST /api/v1/flows/{id}/execute starts one run. trigger_data is merged into the execution’s trigger context, so a node template like {{order_total}} resolves at run time. The run is accepted asynchronously (202) with the new execution id — poll GET /api/v1/flows/executions/{id} for the outcome.

curl -X POST "https://api.orbit.devotel.io/api/v1/flows/flow_9c3f1a8e/execute" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "trigger_data": {
      "contact_id": "ctt_4d1e9a72",
      "order_total": "129.00",
      "currency": "USD"
    }
  }'

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/flows/flow_9c3f1a8e/execute",
  {
    method: "POST",
    headers: {
      "X-API-Key": process.env.ORBIT_API_KEY!,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      trigger_data: {
        contact_id: "ctt_4d1e9a72",
        order_total: "129.00",
        currency: "USD",
      },
    }),
  },
);
console.log(await res.json());

202

{
  "data": {
    "id": "exec_7b2d1aa4",
    "flow_id": "flow_9c3f1a8e",
    "status": "running"
  },
  "meta": {
    "request_id": "req_flow_execute",
    "timestamp": "2026-08-27T12:02:00Z"
  }
}

Poll the execution until data.status leaves running (waiting means a defer node is parked; terminal states are completed, completed_with_errors, failed, timeout). The response carries the normalized per-node step trace — each step’s name, mapped status, and duration_ms — so you can see exactly which node a run stopped on:

curl -X GET "https://api.orbit.devotel.io/api/v1/flows/executions/exec_7b2d1aa4" \
  -H "X-API-Key: dv_live_sk_your_key_here"

200

{
  "data": {
    "id": "exec_7b2d1aa4",
    "flow_id": "flow_9c3f1a8e",
    "status": "completed",
    "steps": [
      { "name": "Trigger", "node_id": "trigger_1", "status": "completed", "duration_ms": 4 },
      { "name": "Send sms", "node_id": "sms_1", "status": "completed", "duration_ms": 231 }
    ],
    "error": null,
    "started_at": "2026-08-27T12:02:01Z",
    "completed_at": "2026-08-27T12:02:02Z"
  },
  "meta": {
    "request_id": "req_flow_execution_get",
    "timestamp": "2026-08-27T12:02:05Z"
  }
}

When the fan-out you want is a contact or a list rather than raw context, use POST /api/v1/flows/{id}/start below — it merges your context the same way but also records which subject was enrolled.

3. Errors

Errors follow the { error, meta } envelope; quote meta.request_id when reporting a failure. 422 — invalid node graph or schedule. The create call below declares a schedule trigger with no cron_expr (the same 422 fires for an unparseable expression, or a graph whose edges reference a node id that doesn’t exist):

curl -X POST "https://api.orbit.devotel.io/api/v1/flows" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Broken schedule",
    "definition": { "nodes": [], "edges": [] },
    "trigger_type": "schedule"
  }'

422

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "trigger_type='schedule' requires a cron_expr",
    "status": 422,
    "details": { "field": "cron_expr" }
  },
  "meta": {
    "request_id": "req_flow_create_422",
    "timestamp": "2026-08-27T12:03:00Z"
  }
}

404 — unknown execution id. Polling an execution id your tenant doesn’t have (a typo, or an id from a different environment) returns 404 in the same envelope:

curl -X GET "https://api.orbit.devotel.io/api/v1/flows/executions/exec_does_not_exist" \
  -H "X-API-Key: dv_live_sk_your_key_here"

404

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Flow execution not found",
    "status": 404
  },
  "meta": {
    "request_id": "req_flow_execution_404",
    "timestamp": "2026-08-27T12:04:00Z"
  }
}

List flows

GET /api/v1/flows

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/flows" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/flows", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/flows", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

Get flows

GET /api/v1/flows/{id}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

List ab-results

GET /api/v1/flows/{id}/ab-results

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ab-results" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ab-results', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ab-results", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ab-results", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ab-results')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ab-results');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

List analytics

GET /api/v1/flows/{id}/analytics

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

List export

GET /api/v1/flows/{id}/export

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/export" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/export', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/export", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/export", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/export')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/export');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

List validate

GET /api/v1/flows/{id}/validate

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/validate" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/validate', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/validate", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/validate", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/validate')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/validate');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

List versions

GET /api/v1/flows/{id}/versions

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/versions" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/versions', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/versions", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/versions", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/versions')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/versions');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

List flow executions

GET /api/v1/flows/executions

Return a cursor-paginated list of the tenant’s flow executions, newest first. Optionally filter by flow_id or lifecycle status. Powers the Flows → Executions history table; each row is a flat summary (status, trigger, steps completed / total, duration) — fetch a single execution by id for its full per-node step trace.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/flows/executions" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/executions', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/flows/executions", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/flows/executions", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows/executions')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows/executions');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

Get a flow execution

GET /api/v1/flows/executions/{id}

Retrieve a single flow execution by id, including its full per-node step trace (name, status, duration, and any lifted error) normalized for the execution-detail timeline. Use it to debug why a specific run completed, waited, or failed. Returns 404 if the execution does not exist in the tenant.

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/flows/executions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/executions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/flows/executions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/flows/executions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows/executions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows/executions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

List summary

GET /api/v1/flows/executions/summary

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/flows/executions/summary" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/executions/summary', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/flows/executions/summary", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/flows/executions/summary", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows/executions/summary')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows/executions/summary');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

List flow templates

GET /api/v1/flows/templates

Return the built-in starter flow templates shown in the builder’s “New Flow” dialog (welcome SMS, OTP verification, abandoned-cart, appointment reminders, lead qualification, FAQ deflection, and more). Each template carries a ready-to-clone React-Flow definition the client copies into a new draft flow.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/flows/templates" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/templates', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/flows/templates", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/flows/templates", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows/templates')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows/templates');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

Create flows

POST /api/v1/flows

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/flows" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/flows", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/flows", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

Create execute

POST /api/v1/flows/{id}/execute

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/execute" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/execute', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/execute", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/execute", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/execute')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/execute');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

Create publish

POST /api/v1/flows/{id}/publish

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/publish" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/publish', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/publish", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/publish", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/publish')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/publish');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

Create simulate

POST /api/v1/flows/{id}/simulate

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/simulate" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/simulate', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/simulate", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/simulate", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/simulate')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/simulate');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

Create start

POST /api/v1/flows/{id}/start

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/start" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/start', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

Create unpublish

POST /api/v1/flows/{id}/unpublish

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/unpublish" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/unpublish', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

Create a flow version snapshot

POST /api/v1/flows/{id}/versions

Capture an immutable snapshot of the flow’s current definition so an operator can roll back later. With an empty body the server snapshots the live definition; the one-time localStorage-migration path may pass an explicit definition + created_at to import a browser-history entry with its original timestamp. Returns the newly-created version with 201.

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/versions" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/versions', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "draft",
    "version": 1,
    "trigger_type": "schedule",
    "cron_expr": "0 9 * * 1",
    "cron_tz": "America/New_York"
  },
  "meta": {
    "request_id": "req_flow_create",
    "timestamp": "2026-08-27T12:00:00Z"
  }
}

Restore a flow version

POST /api/v1/flows/{id}/versions/{versionId}/restore

Restore an older version snapshot onto the flow’s current draft definition. Status is left unchanged — restoring on a published flow keeps the live publish active until the operator re-publishes the now-overwritten draft, so live traffic is never rolled back by accident. Returns the flow after the draft definition is replaced.

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/versions/{versionId}/restore" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/versions/{versionId}/restore', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

Resume a paused flow execution

POST /api/v1/flows/executions/{id}/resume

Resume an execution that is parked on a delay node once its wait has elapsed. Called by the webhook-worker scheduler service-to-service (via X-Internal-Token), and also usable with a normal JWT to replay a stuck run: execution continues from the node wired after resumed_step and the remainder of the graph is processed.

string

required

—

string

string (enum: true|false)

string

required

Id of the flow this execution belongs to.

string

required

Node id of the delay step whose wait has elapsed; the run continues from the node wired after it.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/flows/executions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/resume" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "flow_id": "string",
  "resumed_step": "string"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/executions/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/resume', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "flow_id": "string",
  "resumed_step": "string"
}),
})
console.log(await res.json())

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

Update flows

PUT /api/v1/flows/{id}

string

required

—

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

Delete flows

DELETE /api/v1/flows/{id}

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/flows/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "flow_9c3f1a8e",
    "name": "Weekly re-engagement",
    "status": "published",
    "version": 2
  },
  "meta": {
    "request_id": "req_flow_publish",
    "timestamp": "2026-08-27T12:01:00Z"
  }
}

API Reference

All Endpoints

Flows API

Flows API

Worked flows samples

1. Create the flow draft

2. Execute and poll

3. Errors

List flows

Get flows

List ab-results

List analytics

List export

List validate

List versions

List flow executions

Get a flow execution

List summary

List flow templates

Create flows

Create execute

Create publish

Create simulate

Create start

Create unpublish

Create a flow version snapshot

Restore a flow version

Resume a paused flow execution

Update flows

Delete flows

​Flows API

​Worked flows samples

​1. Create the flow draft

​2. Execute and poll

​3. Errors

​List flows

​Get flows

​List ab-results

​List analytics

​List export

​List validate

​List versions

​List flow executions

​Get a flow execution

​List summary

​List flow templates

​Create flows

​Create execute

​Create publish

​Create simulate

​Create start

​Create unpublish

​Create a flow version snapshot

​Restore a flow version

​Resume a paused flow execution

​Update flows

​Delete flows

Flows API

Worked flows samples

1. Create the flow draft

2. Execute and poll

3. Errors

List flows

Get flows

List ab-results

List analytics

List export

List validate

List versions

List flow executions

Get a flow execution

List summary

List flow templates

Create flows

Create execute

Create publish

Create simulate

Create start

Create unpublish

Create a flow version snapshot

Restore a flow version

Resume a paused flow execution

Update flows

Delete flows