Publish the native chat conversation flow
curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/settings/native-chat/flow \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"version": 1,
"pre_chat_form": {
"enabled": true,
"title": "Before we start",
"fields": [
{
"id": "email",
"label": "Email",
"type": "email",
"required": true
}
]
},
"business_hours": {
"offline_behavior": "collect_email"
},
"faq_deflections": [
{
"id": "pricing",
"question": "What does it cost?",
"answer": "Plans start free; see the pricing page for details.",
"keywords": [
"price",
"cost"
]
}
],
"routing": {
"default_action": "human_inbox",
"rules": [
{
"id": "billing",
"match": {
"type": "keyword",
"value": "invoice"
},
"action": "faq",
"faq_id": "pricing"
}
]
},
"ai_handoff": {
"enabled": true,
"trigger": "after_deflection_miss"
},
"proactive_triggers": []
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/settings/native-chat/flow"
payload = {
"version": 1,
"pre_chat_form": {
"enabled": True,
"title": "Before we start",
"fields": [
{
"id": "email",
"label": "Email",
"type": "email",
"required": True
}
]
},
"business_hours": { "offline_behavior": "collect_email" },
"faq_deflections": [
{
"id": "pricing",
"question": "What does it cost?",
"answer": "Plans start free; see the pricing page for details.",
"keywords": ["price", "cost"]
}
],
"routing": {
"default_action": "human_inbox",
"rules": [
{
"id": "billing",
"match": {
"type": "keyword",
"value": "invoice"
},
"action": "faq",
"faq_id": "pricing"
}
]
},
"ai_handoff": {
"enabled": True,
"trigger": "after_deflection_miss"
},
"proactive_triggers": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
version: 1,
pre_chat_form: {
enabled: true,
title: 'Before we start',
fields: [{id: 'email', label: 'Email', type: 'email', required: true}]
},
business_hours: {offline_behavior: 'collect_email'},
faq_deflections: [
{
id: 'pricing',
question: 'What does it cost?',
answer: 'Plans start free; see the pricing page for details.',
keywords: ['price', 'cost']
}
],
routing: {
default_action: 'human_inbox',
rules: [
{
id: 'billing',
match: {type: 'keyword', value: 'invoice'},
action: 'faq',
faq_id: 'pricing'
}
]
},
ai_handoff: {enabled: true, trigger: 'after_deflection_miss'},
proactive_triggers: []
})
};
fetch('https://api.orbit.devotel.io/api/v1/settings/native-chat/flow', 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.orbit.devotel.io/api/v1/settings/native-chat/flow",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'version' => 1,
'pre_chat_form' => [
'enabled' => true,
'title' => 'Before we start',
'fields' => [
[
'id' => 'email',
'label' => 'Email',
'type' => 'email',
'required' => true
]
]
],
'business_hours' => [
'offline_behavior' => 'collect_email'
],
'faq_deflections' => [
[
'id' => 'pricing',
'question' => 'What does it cost?',
'answer' => 'Plans start free; see the pricing page for details.',
'keywords' => [
'price',
'cost'
]
]
],
'routing' => [
'default_action' => 'human_inbox',
'rules' => [
[
'id' => 'billing',
'match' => [
'type' => 'keyword',
'value' => 'invoice'
],
'action' => 'faq',
'faq_id' => 'pricing'
]
]
],
'ai_handoff' => [
'enabled' => true,
'trigger' => 'after_deflection_miss'
],
'proactive_triggers' => [
]
]),
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://api.orbit.devotel.io/api/v1/settings/native-chat/flow"
payload := strings.NewReader("{\n \"version\": 1,\n \"pre_chat_form\": {\n \"enabled\": true,\n \"title\": \"Before we start\",\n \"fields\": [\n {\n \"id\": \"email\",\n \"label\": \"Email\",\n \"type\": \"email\",\n \"required\": true\n }\n ]\n },\n \"business_hours\": {\n \"offline_behavior\": \"collect_email\"\n },\n \"faq_deflections\": [\n {\n \"id\": \"pricing\",\n \"question\": \"What does it cost?\",\n \"answer\": \"Plans start free; see the pricing page for details.\",\n \"keywords\": [\n \"price\",\n \"cost\"\n ]\n }\n ],\n \"routing\": {\n \"default_action\": \"human_inbox\",\n \"rules\": [\n {\n \"id\": \"billing\",\n \"match\": {\n \"type\": \"keyword\",\n \"value\": \"invoice\"\n },\n \"action\": \"faq\",\n \"faq_id\": \"pricing\"\n }\n ]\n },\n \"ai_handoff\": {\n \"enabled\": true,\n \"trigger\": \"after_deflection_miss\"\n },\n \"proactive_triggers\": []\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.orbit.devotel.io/api/v1/settings/native-chat/flow")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"version\": 1,\n \"pre_chat_form\": {\n \"enabled\": true,\n \"title\": \"Before we start\",\n \"fields\": [\n {\n \"id\": \"email\",\n \"label\": \"Email\",\n \"type\": \"email\",\n \"required\": true\n }\n ]\n },\n \"business_hours\": {\n \"offline_behavior\": \"collect_email\"\n },\n \"faq_deflections\": [\n {\n \"id\": \"pricing\",\n \"question\": \"What does it cost?\",\n \"answer\": \"Plans start free; see the pricing page for details.\",\n \"keywords\": [\n \"price\",\n \"cost\"\n ]\n }\n ],\n \"routing\": {\n \"default_action\": \"human_inbox\",\n \"rules\": [\n {\n \"id\": \"billing\",\n \"match\": {\n \"type\": \"keyword\",\n \"value\": \"invoice\"\n },\n \"action\": \"faq\",\n \"faq_id\": \"pricing\"\n }\n ]\n },\n \"ai_handoff\": {\n \"enabled\": true,\n \"trigger\": \"after_deflection_miss\"\n },\n \"proactive_triggers\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/settings/native-chat/flow")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"version\": 1,\n \"pre_chat_form\": {\n \"enabled\": true,\n \"title\": \"Before we start\",\n \"fields\": [\n {\n \"id\": \"email\",\n \"label\": \"Email\",\n \"type\": \"email\",\n \"required\": true\n }\n ]\n },\n \"business_hours\": {\n \"offline_behavior\": \"collect_email\"\n },\n \"faq_deflections\": [\n {\n \"id\": \"pricing\",\n \"question\": \"What does it cost?\",\n \"answer\": \"Plans start free; see the pricing page for details.\",\n \"keywords\": [\n \"price\",\n \"cost\"\n ]\n }\n ],\n \"routing\": {\n \"default_action\": \"human_inbox\",\n \"rules\": [\n {\n \"id\": \"billing\",\n \"match\": {\n \"type\": \"keyword\",\n \"value\": \"invoice\"\n },\n \"action\": \"faq\",\n \"faq_id\": \"pricing\"\n }\n ]\n },\n \"ai_handoff\": {\n \"enabled\": true,\n \"trigger\": \"after_deflection_miss\"\n },\n \"proactive_triggers\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"flow": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Settings
Publish the native chat conversation flow
Publishes the no-code conversation flow that drives the live widget — the pre-chat form, after-hours behaviour, FAQ deflections, conditional routing rules, AI handoff and behavioral proactive triggers. The body is the full flow document (version: 1); omitted sections fall back to their documented defaults and the stored flow is replaced in full, merged into feature_flags.widget_flow without touching other flag keys. Owner/admin only. Runtime validation stays with the handler’s Zod gate, which answers a malformed payload with the platform 422 envelope.
PUT
/
api
/
v1
/
settings
/
native-chat
/
flow
Publish the native chat conversation flow
curl --request PUT \
--url https://api.orbit.devotel.io/api/v1/settings/native-chat/flow \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"version": 1,
"pre_chat_form": {
"enabled": true,
"title": "Before we start",
"fields": [
{
"id": "email",
"label": "Email",
"type": "email",
"required": true
}
]
},
"business_hours": {
"offline_behavior": "collect_email"
},
"faq_deflections": [
{
"id": "pricing",
"question": "What does it cost?",
"answer": "Plans start free; see the pricing page for details.",
"keywords": [
"price",
"cost"
]
}
],
"routing": {
"default_action": "human_inbox",
"rules": [
{
"id": "billing",
"match": {
"type": "keyword",
"value": "invoice"
},
"action": "faq",
"faq_id": "pricing"
}
]
},
"ai_handoff": {
"enabled": true,
"trigger": "after_deflection_miss"
},
"proactive_triggers": []
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/settings/native-chat/flow"
payload = {
"version": 1,
"pre_chat_form": {
"enabled": True,
"title": "Before we start",
"fields": [
{
"id": "email",
"label": "Email",
"type": "email",
"required": True
}
]
},
"business_hours": { "offline_behavior": "collect_email" },
"faq_deflections": [
{
"id": "pricing",
"question": "What does it cost?",
"answer": "Plans start free; see the pricing page for details.",
"keywords": ["price", "cost"]
}
],
"routing": {
"default_action": "human_inbox",
"rules": [
{
"id": "billing",
"match": {
"type": "keyword",
"value": "invoice"
},
"action": "faq",
"faq_id": "pricing"
}
]
},
"ai_handoff": {
"enabled": True,
"trigger": "after_deflection_miss"
},
"proactive_triggers": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
version: 1,
pre_chat_form: {
enabled: true,
title: 'Before we start',
fields: [{id: 'email', label: 'Email', type: 'email', required: true}]
},
business_hours: {offline_behavior: 'collect_email'},
faq_deflections: [
{
id: 'pricing',
question: 'What does it cost?',
answer: 'Plans start free; see the pricing page for details.',
keywords: ['price', 'cost']
}
],
routing: {
default_action: 'human_inbox',
rules: [
{
id: 'billing',
match: {type: 'keyword', value: 'invoice'},
action: 'faq',
faq_id: 'pricing'
}
]
},
ai_handoff: {enabled: true, trigger: 'after_deflection_miss'},
proactive_triggers: []
})
};
fetch('https://api.orbit.devotel.io/api/v1/settings/native-chat/flow', 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.orbit.devotel.io/api/v1/settings/native-chat/flow",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'version' => 1,
'pre_chat_form' => [
'enabled' => true,
'title' => 'Before we start',
'fields' => [
[
'id' => 'email',
'label' => 'Email',
'type' => 'email',
'required' => true
]
]
],
'business_hours' => [
'offline_behavior' => 'collect_email'
],
'faq_deflections' => [
[
'id' => 'pricing',
'question' => 'What does it cost?',
'answer' => 'Plans start free; see the pricing page for details.',
'keywords' => [
'price',
'cost'
]
]
],
'routing' => [
'default_action' => 'human_inbox',
'rules' => [
[
'id' => 'billing',
'match' => [
'type' => 'keyword',
'value' => 'invoice'
],
'action' => 'faq',
'faq_id' => 'pricing'
]
]
],
'ai_handoff' => [
'enabled' => true,
'trigger' => 'after_deflection_miss'
],
'proactive_triggers' => [
]
]),
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://api.orbit.devotel.io/api/v1/settings/native-chat/flow"
payload := strings.NewReader("{\n \"version\": 1,\n \"pre_chat_form\": {\n \"enabled\": true,\n \"title\": \"Before we start\",\n \"fields\": [\n {\n \"id\": \"email\",\n \"label\": \"Email\",\n \"type\": \"email\",\n \"required\": true\n }\n ]\n },\n \"business_hours\": {\n \"offline_behavior\": \"collect_email\"\n },\n \"faq_deflections\": [\n {\n \"id\": \"pricing\",\n \"question\": \"What does it cost?\",\n \"answer\": \"Plans start free; see the pricing page for details.\",\n \"keywords\": [\n \"price\",\n \"cost\"\n ]\n }\n ],\n \"routing\": {\n \"default_action\": \"human_inbox\",\n \"rules\": [\n {\n \"id\": \"billing\",\n \"match\": {\n \"type\": \"keyword\",\n \"value\": \"invoice\"\n },\n \"action\": \"faq\",\n \"faq_id\": \"pricing\"\n }\n ]\n },\n \"ai_handoff\": {\n \"enabled\": true,\n \"trigger\": \"after_deflection_miss\"\n },\n \"proactive_triggers\": []\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.orbit.devotel.io/api/v1/settings/native-chat/flow")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"version\": 1,\n \"pre_chat_form\": {\n \"enabled\": true,\n \"title\": \"Before we start\",\n \"fields\": [\n {\n \"id\": \"email\",\n \"label\": \"Email\",\n \"type\": \"email\",\n \"required\": true\n }\n ]\n },\n \"business_hours\": {\n \"offline_behavior\": \"collect_email\"\n },\n \"faq_deflections\": [\n {\n \"id\": \"pricing\",\n \"question\": \"What does it cost?\",\n \"answer\": \"Plans start free; see the pricing page for details.\",\n \"keywords\": [\n \"price\",\n \"cost\"\n ]\n }\n ],\n \"routing\": {\n \"default_action\": \"human_inbox\",\n \"rules\": [\n {\n \"id\": \"billing\",\n \"match\": {\n \"type\": \"keyword\",\n \"value\": \"invoice\"\n },\n \"action\": \"faq\",\n \"faq_id\": \"pricing\"\n }\n ]\n },\n \"ai_handoff\": {\n \"enabled\": true,\n \"trigger\": \"after_deflection_miss\"\n },\n \"proactive_triggers\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/settings/native-chat/flow")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"version\": 1,\n \"pre_chat_form\": {\n \"enabled\": true,\n \"title\": \"Before we start\",\n \"fields\": [\n {\n \"id\": \"email\",\n \"label\": \"Email\",\n \"type\": \"email\",\n \"required\": true\n }\n ]\n },\n \"business_hours\": {\n \"offline_behavior\": \"collect_email\"\n },\n \"faq_deflections\": [\n {\n \"id\": \"pricing\",\n \"question\": \"What does it cost?\",\n \"answer\": \"Plans start free; see the pricing page for details.\",\n \"keywords\": [\n \"price\",\n \"cost\"\n ]\n }\n ],\n \"routing\": {\n \"default_action\": \"human_inbox\",\n \"rules\": [\n {\n \"id\": \"billing\",\n \"match\": {\n \"type\": \"keyword\",\n \"value\": \"invoice\"\n },\n \"action\": \"faq\",\n \"faq_id\": \"pricing\"\n }\n ]\n },\n \"ai_handoff\": {\n \"enabled\": true,\n \"trigger\": \"after_deflection_miss\"\n },\n \"proactive_triggers\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"flow": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Headers
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.
Required string length:
1 - 255Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. 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.
Available options:
true, false Body
application/json
The published conversation flow document.
The published conversation flow document.
Flow contract version; always 1.
Available options:
1 Branding overrides on top of the base config — launcher_text, header_title, header_subtitle, primary_color (#rrggbb), avatar_url.
Form collected before the conversation starts — enabled, title, submit_label and up to 12 fields of type text, email, phone, select or textarea.
After-hours behaviour — offline_behavior (show_away_message, hide_launcher or collect_email) plus away_title / away_message.
FAQ entries answered inline before a human is paged — id, question, answer and lower-cased routing keywords.
Conditional routing — default_action plus top-to-bottom rules matching keyword or url_path, each resolving to ai_agent, human_inbox, faq or collect_email.
AI-agent handoff — enabled, optional agent_id, trigger (immediate, after_deflection_miss, on_keyword) and keywords.
Behavioral auto-invite rules — ANDed conditions (url_match, time_on_page, scroll_depth, exit_intent, repeat_visit, cart_value), a show_message / open_chat action and per-visitor frequency caps.