# Building Your First Workflow

This guide walks you through creating a simple workflow that fetches data from an endpoint, filters it, and sends you a notification. By the end, you'll understand the basics of the workflow editor.

# Step 1: Create a New Workflow

  1. Switch to the Workflows tab in the sidebar
  2. Click the + button to create a new workflow
  3. A new workflow opens in the editor with a Trigger node already placed on the canvas

# Step 2: Get to Know the Editor

The workflow editor has two main areas:

  • Canvas (left) — Where you place and connect nodes. You can drag nodes around to arrange them.
  • Config Panel (right) — Where you configure the selected node's settings. Click a node on the canvas to select it and see its options here.

The toolbar at the top provides:

  • The workflow name (click to rename)
  • Save button (appears when you have unsaved changes)
  • Auto Layout — Automatically arranges nodes in a clean layout
  • Add Node — Opens the node picker to add new nodes
  • Run Log — View the results of the last run (appears after running)
  • Play button — Run the workflow

# Step 3: Configure the Trigger

Click the Trigger node on the canvas. In the config panel, you'll see options for when the workflow runs:

  • Manual — You'll click the Play button to run it
  • Scheduled — Runs automatically at an interval (every X minutes, hourly, daily, or weekly)

For this first workflow, leave it as Manual.

# Step 4: Add a Data Source Node

  1. Click Add Node in the toolbar (the + icon)
  2. Select Data Source from the list
  3. A new Data Source node appears on the canvas

Click the Data Source node and configure it:

  • Select which endpoint to fetch data from (e.g., "Open Alerts")

Now connect the Trigger to the Data Source:

  • Drag from the output port (bottom) of the Trigger node to the input port (top) of the Data Source node
  • A connection line appears linking them

# Step 5: Add a Filter Node

  1. Click Add Node and select Filter
  2. Click the Filter node to configure it:
    • Set up a condition (e.g., status equals "critical")
  3. Connect the Data Source node's output to the Filter node's input

# Step 6: Add a Notification Node

  1. Click Add Node and select Notification
  2. Click the Notification node to configure it:
    • Set the notification title (e.g., "Critical Alerts Found")
    • Set the message (you can reference data from previous nodes, like the item count)
  3. Connect the Filter node's output to the Notification node's input

# Step 7: Save and Run

  1. Click Save in the toolbar (or press Cmd+S)
  2. Click the Play button to run the workflow

Weavestream executes each node in order:

  1. The Trigger fires
  2. The Data Source fetches items from your endpoint
  3. The Filter narrows the list to critical items
  4. The Notification sends a macOS notification with the results

A green checkmark appears in the toolbar when the run completes successfully. If something goes wrong, an orange warning icon appears instead.

# Step 8: Check the Run Log

Click the Run Log button in the toolbar to see detailed results:

  • Which nodes ran and in what order
  • How long each step took
  • What data was passed between nodes
  • Any errors that occurred

# Rearranging Nodes

You can move nodes around the canvas by dragging them. If things get messy, click Auto Layout to have Weavestream automatically arrange all nodes in a clean, readable layout.

# Editing Connections

To remove a connection, you can delete it from the canvas. Weavestream validates connections and won't let you create:

  • Cycles — A node can't connect back to an earlier node in the flow
  • Duplicate inputs — Each input port accepts only one connection

# What's Next?

Now that you understand the basics, explore more node types:

  • Add an AI Analysis node to get intelligent insights
  • Use a Condition node to branch your workflow based on results
  • Add a Save File node to export data to CSV or JSON

See the full list in the Workflow Node Reference.