Core Concepts of FlowAPI
Understanding the core concepts of FlowAPI is key to unlocking its full potential. This page breaks down the fundamental building blocks and collaboration features that make FlowAPI a powerful platform for visual workflow automation.
Collaboration in FlowAPI
FlowAPI is designed with teamwork in mind, enabling seamless collaboration throughout the workflow design and management process.
Real-Time Co-editing
Multiple users can work on the same flow simultaneously. Changes are synced in real-time, allowing for efficient parallel development and instant feedback.
How it Works
Each collaborator's cursor and selections are visible, providing clarity on who is editing what part of the flow.
Flow Sharing
Share your flows easily with team members or even publicly with different levels of access.
- Private Sharing: Invite specific users to view or edit flows.
- Public Links: Generate shareable links for read-only access to showcase your workflows. (Coming Soon!)
Control Access
Manage permissions to ensure the right level of access for each collaborator.
Versioning & History
FlowAPI automatically saves versions of your workflows, allowing you to track changes and revert to previous states if needed. (Conceptual - detailed history view might be a future feature)
Peace of Mind
Experiment freely knowing you can always roll back to a working version of your flow.
Comments & Annotations (Future)
Soon, you'll be able to add comments directly onto the canvas or specific nodes to facilitate discussions and leave notes for your team.
Fundamental Building Blocks
These are the essential components you'll work with when creating automations in FlowAPI.
Flows
A Flow is the main canvas where you design your automated processes. Think of it as a blueprint for a specific task, like "Process New User Signups" or "Generate Weekly Sales Reports". Each flow consists of interconnected nodes that define the sequence of operations.
Nodes
Nodes are the individual operational units within a flow. Each node performs a specific action, such as fetching data from an API, transforming data, making a decision, or sending a notification.
Node Categories
Nodes can be broadly categorized into:
- Input Nodes: Trigger flows or bring data in (e.g., Webhook, Scheduler).
- Processing Nodes: Manipulate data (e.g., Transform, Code).
- Logic Nodes: Control flow paths (e.g., Conditional, Loop).
- Output Nodes: Send data out or perform final actions (e.g., Send Email, API Call).
Edges
Edges are the connectors that link nodes together. They define the direction of data flow and the order of execution. An edge typically runs from an output handle of one node to an input handle of another.
Variables & Data Context
FlowAPI allows you to manage and pass data dynamically throughout your flows.
- Node Outputs: Data produced by a node can be referenced by subsequent nodes. Example:
{{api_node.response.body.id}} - Flow Context (
flowData): A temporary storage accessible by all nodes within a single execution of a flow. Useful for passing data between non-adjacent nodes or storing intermediate results. Accessed via{{flowData.yourVariable}}. - Environment Variables: Store sensitive data (like API keys) or configuration values that can be used across multiple flows within a specific environment. Accessed via
{{env.YOUR_API_KEY}}.
Execution Model
Flows can be triggered in various ways (e.g., manually, via webhook, on a schedule( SOON ) ). Once triggered, the execution engine processes the nodes sequentially, following the paths defined by the edges.
Monitoring Execution
You can monitor the execution status and view logs for each run to debug and understand your flow's behavior.
Learn More!
Dive deeper into each concept by exploring the specific documentation sections for Nodes, UI Panels, and practical Guides.