Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "id": "dest_7a2c",
    "name": "Sales Hermes",
    "provider": "hermes",
    "deliveryMode": "webhook_queue",
    "endpointUrl": "https://ops.example.com/flowyte/escalations",
    "allowedChannels": [
      "chat"
    ],
    "capabilities": [
      "reply",
      "resolve"
    ],
    "contextProfile": "sales",
    "transcriptWindow": 20,
    "claimSlaSeconds": 120,
    "status": "unverified",
    "fallbackRef": "email:sales@example.com",
    "signingSecret": "whsec_3f9a1c2b7e10a24d51b6f2c8d4e5a9f0",
    "createdAt": "2026-07-12T09:00:00.000Z",
    "updatedAt": "2026-07-12T09:00:00.000Z"
  }
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Escalation

Create an escalation destination (signing secret shown once)

Register an external operator-agent endpoint. The server generates a whsec_ signing secret returned EXACTLY ONCE in this response and never again — store it immediately. The endpoint must be https and pass an SSRF/private-IP check; provider must be an AI Harness whose integration is connected; any sms channel requires the org’s 10DLC/TCR campaign to be ACTIVE. The new destination starts unverified — run testEscalationDestination to flip it active before it can route live. capabilities is a free-form list of capability tokens the external agent advertises (e.g. “reply”, “resolve”); fallbackRef uses the grammar external:<id> | email:<address> | none.

POST

escalation-destinations

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "id": "dest_7a2c",
    "name": "Sales Hermes",
    "provider": "hermes",
    "deliveryMode": "webhook_queue",
    "endpointUrl": "https://ops.example.com/flowyte/escalations",
    "allowedChannels": [
      "chat"
    ],
    "capabilities": [
      "reply",
      "resolve"
    ],
    "contextProfile": "sales",
    "transcriptWindow": 20,
    "claimSlaSeconds": 120,
    "status": "unverified",
    "fallbackRef": "email:sales@example.com",
    "signingSecret": "whsec_3f9a1c2b7e10a24d51b6f2c8d4e5a9f0",
    "createdAt": "2026-07-12T09:00:00.000Z",
    "updatedAt": "2026-07-12T09:00:00.000Z"
  }
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Body

application/json

name

string

required

provider

enum<string>

required

Available options:

hermes,

openclaw

endpointUrl

string<uri>

required

https required; validated against the SSRF/private-IP guard.

allowedChannels

enum<string>[]

Defaults to [chat] when omitted. sms requires an ACTIVE 10DLC/TCR campaign.

Available options:

chat,

sms

capabilities

string[]

contextProfile

enum<string>

default:general

Available options:

general,

sales,

support,

billing,

scheduling

transcriptWindow

integer

default:20

claimSlaSeconds

integer

default:120

fallbackRef

string

Response

Created destination (includes the show-once signingSecret).

success

boolean

required

data

object

required

Show child attributes

message

string

errors

object[]

Show child attributes

List escalation destinations Get an escalation destination

Using the API

Endpoints

Create an escalation destination (signing secret shown once)

Authorizations

Body

Response