Affects
Teams using Flowker guides or API reference. This update applies to the public documentation portal. It does not change the runtime API behavior unless the linked product documentation says otherwise.
What changed
Flowker documentation
Flowker now has full documentation coverage across guides, API reference, and OpenAPI specification. This release includes 11 guide pages, the API reference, and an OpenAPI 3.1 spec — all verified against the Flowker source code and available in English, Portuguese, and Spanish.New pages
Overview
- What is Flowker — Product overview, architecture, and where Flowker fits in the Lerian platform
- Why Flowker — Key differentiators, design principles, and the problems Flowker solves
- Flowker concepts — Core concepts: workflows, nodes, edges, executor configurations, provider configurations, catalog, and executions
Guides
- Getting started — End-to-end walkthrough: explore the catalog, connect your providers, define workflows, and execute
- Integration guide — Deep dive into provider configuration, authentication types, field mapping, webhook triggers, circuit breaker, and retry behavior
- Workflow design guide — Workflow lifecycle, node types, edge conditions, design patterns (sequential, conditional, parallel fan-out), and technical limits
- Working with request and response data — Input/output mapping, inline transformations, Kazaam operations, and execution order
- Security — Access Manager authentication, provider authentication, CORS policy, TLS, and data protection
- Compliance — Validation before the ledger write, the step-level record of every execution, and regulatory context
- Observability guide — OpenTelemetry traces, Prometheus metrics, health check endpoints, and Grafana dashboard setup
- Environment variables — Complete reference for all server, database, authentication, and observability configuration options
Use cases
- Use cases — Real-world scenarios: payment processing, fraud detection, KYC/AML, reconciliation, and notification orchestration
API reference
- API quick start — Getting started with the Flowker API
- Error list — Complete error code reference
- Implementing observability — Observability setup guide for the API
OpenAPI specification
- Flowker OpenAPI 3.1 spec — The specification that the API reference pages render from
Impact
This is a documentation update. Existing integrations do not need a migration from this release note alone.
What you need to do
1
Review the Flowker documentation before building or updating workflow orchestration integrations.