Your first flow
By the end of this tutorial you’ll have a deployed integration flow that accepts an HTTP POST and logs the body. Replace the log step with real work — Salesforce, SAP, Kafka — and you’ve got a working integration.
1. Open the designer
Section titled “1. Open the designer”Visit https://designer.<your-root>. You’ll land on the Integration
Flows page (master-detail layout).
2. Create a flow
Section titled “2. Create a flow”Click + New flow in the toolbar. The modal asks for:
- Name — e.g.
Hello webhook. Use aSource → Targetpattern for flows that bridge real systems. - Category — pick from the catalogue (or add
Qualityetc. via Settings → Flow categories). - Initial state — flows always start as
Draft.
Click Create & open designer. You’re now in the editor.
3. Wire the canvas
Section titled “3. Wire the canvas”A fresh flow has a single Webhook trigger and an empty step. From the palette on the left:
- Drag a Log step onto the canvas.
- Connect the webhook → log step (drag from the trigger’s output handle to the log node’s input handle).
- Click the log step. In the inspector panel: set Tag to
hello-webhook.
4. Save + Deploy
Section titled “4. Save + Deploy”Top-right of the editor:
- Save — writes the YAML to disk
- Deploy — pushes to the runtime (auto-saves first if dirty)
Wait for the green badge: Deployed <timestamp>.
5. Trigger it
Section titled “5. Trigger it”Each new flow gets a route ID slugified from its name. The webhook
trigger lives at /api/<route-id> on the runtime. Try it:
curl -X POST https://runtime.<your-root>/api/hello-webhook \ -H "Content-Type: application/json" \ -d '{"hello":"world"}'You should get back ok (the default response body for a fresh flow).
Open the runtime’s logs:
ssh <host> "docker logs --tail 20 \$(docker ps --format '{{.Names}}' | grep pipebase-runtime)"You’ll see your hello-webhook log line with the {"hello":"world"}
body.
What now?
Section titled “What now?”- Promote to prod — push this flow through dev → staging → prod environments
- Concepts: Flows — what a flow really is, the status lifecycle, and what’s in a YAML
- API reference — every
/_api/*and/api/*endpoint