Workflows
Author the workflows inside an integration using the integration-scoped workflow editor — switch between an integration's workflows, test them, and publish a new integration version.
The integration workflow editor is where your team builds the workflows that make up an integration. You open it from the Integrations list — click an integration's name or use its View Workflows menu action — and it opens on one of the integration's workflows.
The visual canvas itself (adding triggers and actions, wiring nodes, configuring properties, using data pills) works exactly the same as the automation project editor. This page covers only what is specific to integrations: the workflows sidebar, the integration breadcrumb, the settings menu, test execution, and integration versioning/publishing. For the canvas mechanics, see Building Workflows.
Editor layout
| Area | What it is |
|---|---|
| Workflows sidebar (left) | Switch between the workflows in the integration, search and sort them, and add a new workflow. Toggle it with the sidebar button at the far left of the header. |
| Breadcrumb (header, left) | Shows the integration name and a workflow selector dropdown for switching workflows. |
| Header actions (header, right) | Settings menu, output panel, test/chat, and publish. |
| Canvas (center) | The visual workflow editor — same as the automation workflow editor. |
Switching between an integration's workflows
An integration can contain many workflows. There are two ways to move between them:
- Breadcrumb workflow selector — click the workflow name in the header breadcrumb and pick another workflow from the Workflows dropdown.
- Workflows sidebar — click any workflow card in the left sidebar. The currently open workflow is highlighted.
Using the workflows sidebar
-
Open the sidebar with the sidebar toggle button at the far left of the header (if it is collapsed).
-
Use the integration selector at the top of the sidebar to change which integration's workflows are listed. Selecting the "all" option lists workflows across every integration, grouped by integration.
-
Type in the Search workflows box to filter the list by name.
-
Click the sort button (funnel icon) to reorder the list:
Option Order Last edited Most recently modified first (default). Date created Newest first. A-Z Alphabetical by workflow name. Z-A Reverse alphabetical. -
Each workflow card shows the workflow's component icons, its name, and when it was last edited. Click a card to open that workflow.
Adding a workflow
Click New Workflow in the sidebar (or New Workflow from the integration's menu on the Integrations list). In the dialog, provide a workflow Label and an optional Description, then save. ByteChef adds the workflow to the current integration and opens it in the editor.
Settings menu
Click the settings (gear) button in the header to open the settings menu. It has two tabs: Workflow and Integration.
Workflow tab
| Action | Description |
|---|---|
| Edit | Rename the current workflow or change its description. |
| Export | Download the current workflow definition as a file. |
| Delete | Permanently delete the current workflow. A confirmation dialog appears first. |
Integration tab
| Action | Description |
|---|---|
| Edit | Open the integration dialog to change the integration's name, category, tags, or permission expression. |
| Import Workflow | Add a workflow to the integration by uploading a .json, .yaml, or .yml workflow definition file. |
| Integration History | Open the version history panel (see below). |
| Delete | Permanently delete the integration and every workflow it contains. |
Deleting an integration asks "Are you absolutely sure?" and warns that the action cannot be undone and will permanently delete the integration and the workflows it contains. Click Delete to confirm or Cancel to abort.
Testing a workflow
Use the header action buttons on the right to run and inspect the workflow you are editing.
| Button | Action |
|---|---|
| Test | Run the current workflow once for testing. The label changes based on the trigger — for a chat-based trigger the button reads Chat instead and starts the chat. |
| Stop | Appears while a test run is in progress. Click it to stop the running workflow. |
| Output (chevron icon) | Toggle the output panel that shows the current workflow's most recent test execution output. |
The Test button is disabled until every required workflow input parameter, connection, and component property is set. Hover the button to see why it is disabled.
Test runs execute against the draft version of the integration and are for building and verifying workflows — they do not affect connected users. Connected users only ever run published versions activated through Integration Configurations.
Publishing an integration version
Publishing snapshots the integration's current draft workflows into a new, immutable published version that you can then activate for connected users.
- Click Publish in the header.
- In the popover, optionally enter a Description (up to 256 characters) summarizing what changed in this version.
- Click Publish.
When you publish, ByteChef:
- Increments the integration's version number.
- Duplicates each of the integration's workflows so the newly published version is frozen and independent of continued draft editing.
- Records the description and publish timestamp in the version history.
Editing continues on the draft; published versions are never changed. Only published versions can be activated in an environment through Integration Configurations.
Integration version history
Open Integration History from the settings menu's Integration tab to view the Integration Version History panel.
Each entry shows:
- The version number (for example,
V1,V2). - The publish date and time (published versions only).
- A status badge — PUBLISHED or DRAFT.
- The description you entered when publishing, expandable to read the full text ("No description." when none was provided).
The current draft version appears at the top and cannot be expanded, since it has no publish record yet.
AI Copilot
Coming soon. The AI Copilot is on the upcoming release track and is not yet available in the latest released version of ByteChef.
The integration workflow editor includes the AI Copilot panel — an integration-scoped assistant with Ask and Build modes for understanding and building the current integration's workflows. Copilot is an Enterprise Edition feature and is disabled by default.
Related
- Integrations — the list where you create and manage integrations.
- Building Workflows — the shared visual editor mechanics (canvas, nodes, properties, data pills).
- Integration Configurations — activate a published version for connected users.
- Permission Expressions — restrict which connected users see an integration or a specific workflow.
How is this guide?
Last updated on