​

Flow Templates

​

Where the catalog appears

• Flows > Templates — the third tab on the Flows hub.
• Deep-link — …/flows?tab=templates. The legacy /flows/templates path redirects to the tab URL, so existing bookmarks keep working.

​

The gallery anatomy

• Search box — matches against template name, description, and channel labels, so survey, 24h, and whatsapp are all valid queries.
• Category chips — All, then the six categories the catalog uses: Welcome, Reminder, Survey, Nurture, Escalation, Custom.
• Template cards — each card shows the template’s name and description, its category badge, a channel badge per channel it spans, its node count, and a schematic preview of the flow graph.
• Incremental reveal — the gallery renders nine cards at a time; Show more grows the list toward the full catalog, and narrowing the search or category resets the window.

​

Clicking a template: what happens to the draft

• Nothing is wired to your account yet. The trigger node carries a placeholder Trigger Source (for example “Schedule” on the reminder template); set it to a real number, sender, or schedule before you deploy.
• The message copy is placeholder text. Bodys and subjects ship with {{...}} placeholders such as {{phone}} and {{otp}}; replace the sample copy with your own wording.
• Save creates a new flow. The draft has no name or flow of its own until you save — at which point it is an ordinary flow that shares the template’s shape but no longer references it. Editing the draft later never writes back to the catalog.
• API parity for this path: seeding a draft over the API is GET /api/v1/flows/templates (pick your template), then POST /api/v1/flows with the template’s definition as your starting graph.

​

API parity

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

import { Orbit } from "@devotel-orbit/node";

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

// The Node SDK has no typed flow-template helper — reach the endpoint
// through the generic orbit.request escape hatch (auth, retries, and the
// same { data, meta } envelope as the typed resources). Paths are relative
// to /api/v1.
const catalog = await orbit.request("GET", "/flows/templates");

console.log(catalog.data.map((t) => t.id));  // ["tpl_welcome_sms", ...]

from orbit_sdk import OrbitClient

client = OrbitClient.from_env()  # reads ORBIT_API_KEY

# The Python SDK has no typed flow-template helper either — call it
# through the client.request escape hatch. Keyword args match the typed
# helpers pass-through shape.
catalog = client.request("GET", "/flows/templates")

print([t["id"] for t in catalog["data"]])  # ["tpl_welcome_sms", ...]

client := orbit.NewClient(os.Getenv("ORBIT_API_KEY"))

// Same path via the Go SDK's client.Request escape hatch — nil query,
// nil body, and the result unmarshals into a map.
var catalog map[string]any
if err := client.Request(
    context.Background(),
    "GET",
    "/flows/templates",
    nil,
    nil,
    &catalog,
    "",
); err != nil {
    panic(err)
}

fmt.Println(catalog["data"])  // []any of template objects

​

A template graph, in full

{
  "nodes": [
    {
      "id": "trigger-1",           // unique node id, edges reference these
      "type": "trigger",           // node type from the overview taxonomy
      "position": { "x": 50, "y": 200 },  // canvas coordinates
      "data": {
        "label": "Trigger",                    // canvas label
        "triggerType": "Incoming SMS"          // placeholder — set a real source
      }
    },
    {
      "id": "sendSms-1",
      "type": "sendSms",
      "position": { "x": 350, "y": 200 },
      "data": {
        "label": "Send Welcome SMS",
        "to": "{{phone}}",                     // placeholder variable
        "body": "Welcome to {{company}}!"      // placeholder copy — rewrite it
      }
    }
  ],
  "edges": [
    {
      "id": "e-trigger-sms",
      "source": "trigger-1",       // executes trigger-1, then sendSms-1
      "target": "sendSms-1",
      "animated": true             // cosmetic canvas styling only
    }
  ]
}

curl -H "X-API-Key: dv_live_sk_..." \
  -H "Content-Type: application/json" \
  -X POST https://api.orbit.devotel.io/api/v1/flows \
  -d '{"name": "My Welcome SMS", "definition": <the template definition>}'

import { Orbit } from "@devotel-orbit/node";

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

// The Node SDK has no typed flow helper — both reads and creates go through
// the generic orbit.request escape hatch (auth, retries, idempotency key on
// the POST). Paths are relative to /api/v1.
const catalog = await orbit.request("GET", "/flows/templates");
const template = catalog.data.find((t) => t.id === "tpl_welcome_sms");

const flow = await orbit.request("POST", "/flows", {
  name: "My Welcome SMS",
  definition: template.definition,
});

console.log(flow.data.id);  // flow_...

from orbit_sdk import OrbitClient

client = OrbitClient.from_env()  # reads ORBIT_API_KEY

# The Python SDK has no typed flow helper either — GET the catalog, pick the
# template, then POST its definition back as the new flow's graph.
catalog = client.request("GET", "/flows/templates")
template = next(t for t in catalog["data"] if t["id"] == "tpl_welcome_sms")

flow = client.request(
    "POST",
    "/flows",
    json_body={
        "name": "My Welcome SMS",
        "definition": template["definition"],
    },
)

print(flow["data"]["id"])  # flow_...

client := orbit.NewClient(os.Getenv("ORBIT_API_KEY"))

// Same two calls via the Go SDK's client.Request escape hatch.
var catalog map[string]any
if err := client.Request(
    context.Background(), "GET", "/flows/templates", nil, nil, &catalog, "",
); err != nil {
    panic(err)
}

var definition map[string]any
for _, t := range catalog["data"].([]any) {
    tpl := t.(map[string]any)
    if tpl["id"] == "tpl_welcome_sms" {
        definition = tpl["definition"].(map[string]any)
        break
    }
}

var flow map[string]any
err := client.Request(
    context.Background(),
    "POST",
    "/flows",
    nil,
    map[string]any{
        "name":       "My Welcome SMS",
        "definition": definition,
    },
    &flow,
    "",
)
if err != nil {
    panic(err)
}

fmt.Println(flow["data"].(map[string]any)["id"])  // flow_...

​

Clone, customize, publish

1. Open the Templates tab — Flows > Templates, or deep-link …/flows?tab=templates. Filter by category chip or search until the starter matches your case.
2. Select Use Template on its card. The Flow Builder opens with ?template=<id> in the URL and the template’s graph on a fresh, unsaved canvas.
3. Set the trigger source. The trigger node carries a placeholder Trigger Source — point it at a real number, sender, or schedule. With the node selected, set the field in the node’s configuration panel. Until you do, the flow cannot fire.
4. Rewrite the copy. Message nodes ship with placeholder body text and {{...}} variables such as {{phone}} and {{otp}}. Keep the variables your event payload fills, rewrite the surrounding wording in your voice, and delete placeholders you don’t use.
5. Set a conversion goal (optional). If the flow drives an outcome — a reply, a confirmed appointment, a completed purchase — set the flow’s goal so flow analytics can report per-node conversion against it. Covered in Flows overview.
6. Validate. Save the draft, then run GET /api/v1/flows/:id/validate — it flags disconnected nodes, a missing trigger, malformed branch weights, and illegal cycles before anything goes live. The full check list is in Flows overview.
7. Publish. With a real trigger source and your own copy in place, publish from the builder. The cloned flow appears in My Flows (the first tab on the Flows hub) with status Published, and starts executing against new events.

​

Pick a template per use case

​

Template, duplicate, or blank canvas

​

One example per category

​

Known limits

• No per-tenant authoring — you cannot register or save a template back into the gallery.
• No versioning or deletion — templates don’t carry versions, and the catalog is not tenant-editable.
• Clone, don’t upload — the supported way to keep a reusable flow shape is to own a draft shaped like it. Clone a starter with Use Template and save, or duplicate-define from a flow you already have: GET the flow, then POST /api/v1/flows with the same definition under a new name.

​

Next steps

• Flow Builder — edit the cloned draft
• Flows overview — trigger catalog and node taxonomy
• Flow Executions — inspect how a published flow runs
• Flows API — clone a template and manage flows over the API