Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Connectors

Connector bindings map a workflow’s service_task logical action name to a connector type + config, per tenant. See Connectors § Overview for how a binding is used at execution time, and HTTP connector for the http type’s full config schema and error contract.

Method & pathDescription
GET /connectorsList the tenant’s connector bindings
PUT /connectors/{action}Create or replace a binding. Body: { "type": "echo|noop|http", "config": { ... } }
DELETE /connectors/{action}Remove a binding
curl -sS -X PUT "$RULEFLOW_API/api/connectors/disburse-funds" \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{ "type": "http", "config": { "url": "https://payouts.acme.internal/disburse", "method": "POST", "auth": { "kind": "bearer", "token": "..." } } }'
{ "action": "disburse-funds", "type": "http" }
curl -sS "$RULEFLOW_API/api/connectors" -H "Authorization: Bearer $TOKEN"
[
  { "action": "disburse-funds", "type": "http", "config": { "...": "..." } },
  { "action": "notify", "type": "echo", "config": {} }
]

Built-in types

TypeBehavior
echoReturns the input verbatim as the task result — for wiring/testing a workflow’s service-task shape before a real integration exists
noopSucceeds immediately with an empty result
httpCalls an external HTTP endpoint — see HTTP connector

PUT with an unknown type returns 400. For type: "http", the config is validated against the locked schema (a required url, an optional method/auth.kind/timeoutMs/retry) before the binding is saved — see the next page for the full contract.

Config at rest

Connector configs may carry secrets (API keys, bearer tokens). They are encrypted at rest under a per-tenant envelope before being written to storage — see Encryption at rest.