Skip to content

Egress HTTP

Responsibility

Outbound HTTP capability provider for workflow service_call steps.

Capabilities:

  • egress.http.call — generic HTTP request (POST /call)
  • http.connection — connection type (base_url, headers, OAuth, …)

Architecture

Capability provider (see Deploy integration contract):

  • Registers with capability-registry at startup
  • Orchestrator discovers the endpoint via the registry
  • No orchestrator EGRESS_*_URL discovery path

Inbound Authentication

  • internal-only service, called by orchestrator after registry lookup

Outbound Authentication

  • per-request headers from connection/step config
  • optional OAuth client-credentials handled at orchestrator layer (connection credential isolation)

/call payload

Field Default Description
method GET HTTP method
url required Absolute URL (orchestrator joins connection base_url + relative path)
headers {} Request headers (connection default_headers are merged in)
body null Optional request body string
timeout_seconds service default Downstream timeout
fail_on_error_status false When true, downstream status >= 400 becomes provider HTTP 502 so the orchestrator marks the step failed. The 502 detail still carries the normal /call envelope (status_code, headers, body) plus message, so try/catch can inspect the downstream response. When false, the step stays successful and status_code is returned in the JSON body.
accepted_status_codes null When fail_on_error_status is true, only these codes are treated as success (overrides the default < 400 rule). Example: allow 404 while still failing other errors: [200, 404].

Designer (capability egress.http.call) exposes these as form fields with payload_key, including Fail on HTTP error status and Accepted status codes.

Example workflow step

- id: fetch_item
  type: service_call
  capability_name: egress.http.call
  capability_version: "^1.0"
  path: /call
  connection: erpnext
  method: GET
  url: "/api/resource/Item/{item_id}"
  fail_on_error_status: true
  request_timeout_seconds: 60
  values:
    item_id: "request:xml:/Message/id"
  timeout_seconds: 60

See also demos such as ERPNext / HTTP-based examples under flows/workflows/, the SOAP over HTTP + XSLT recipe (soap_http_xslt_demo), and Workflow YAML.

Health

  • GET /healthz
  • GET /readyz
  • GET /internal/capabilities