chatleadr Docs

Using the Workflow Editor

The canvas is where a workflow is drawn. Each node's own settings are in the node reference.

chatleadr Check an order Bot: Patio Warehouse · Workflow Editor Actions Start FlowStart NodeChatbot Trigger Look up the orderAPI RequestGET /orders/:number SendAPIFormDecisionFunctionWaitWebhookMenuEnd Look up the order Method GET URL https://api.example.com/… Headers (JSON) Done 1 Header: name, save, close 2 Canvas: drag to pan 3 Palette and zoom 4 Properties, for the selected node
The four regions of the editor. Everything you do to a node happens in the panel on the right; everything you do to the canvas happens with the pointer.

Start From a Template#

When you open a workflow whose canvas holds only the Start node, the editor asks how you want to start:

  • Start from scratch: an empty canvas with only the Start node.
  • Capture a lead: asks for a name, email and enquiry, then sends the lead to your lead destinations.
  • Request a callback: asks for a name, phone number and a good time to call, then sends the lead to your lead destinations.
  • Answer common questions: answers your most common questions from a menu, and takes the visitor's details when they ask to talk to someone.

A template arrives on the canvas with its nodes and wires in place, and its messages are examples: edit each one, then save with Actions → Save Flow. To go back to the empty canvas, press Ctrl+Z.

Every new workflow, from a template or blank, stays off until you write its description and turn on Let the bot start this. See what a workflow is.

Undo a Change#

Press Ctrl+Z to undo the last change to the canvas, and Ctrl+Y to redo it. On a Mac, press Command+Z to undo and Shift+Command+Z to redo. The Undo and Redo buttons do the same.

Undo covers adding, moving, connecting and deleting nodes, and changes to a node's settings. While you are typing in a field, Ctrl+Z undoes your typing in that field instead.

The history lasts until you close or reload the editor. The workflow on the server is whatever you last saved, so save with Actions → Save Flow before you leave.

Add a Node#

Click a node type in the palette. The node appears in the middle of the current view, selected. Click its gear to open its settings.

A workflow starts with one Start node on the canvas, and the palette does not add another. Drag a node by anywhere except its gear to move it.

Connect Two Nodes#

Press on an output port, the dot beside each way out of a node, and drag it onto the target card, which highlights while you are over it.

Look up the orderAPI RequestGET /orders/:number Give them the statusChat MessageOrder order_number ships… Drop anywhere on the card, not only on the dot What the canvas allows One wire per output port. Connecting a port that already has one replaces it, silently. One wire per pair of nodes. The second is refused. Nothing connects into Start. It has no input port. A wire back to an earlier node is allowed, and warned about.
Dropping a wire anywhere on a node connects it. A port already carrying a wire keeps only the new one.

Four rules apply:

  • One wire per output port. A second wire dropped on a port that already has one silently removes the first. Press Ctrl+Z to get the first one back.
  • One wire per pair of nodes. The same two nodes cannot be joined twice; the target stops highlighting to say so.
  • Nothing connects into the Start node. It has no input port.
  • A wire may point backwards. Connecting to an earlier node builds a loop. See execution limits.

Delete a Node or a Connection#

To delete a node, open its properties panel with the gear, then click the red trash button. Every wire attached to the node goes with it. The Start node cannot be removed and has no delete button.

Delete a node Say helloChat MessageHi there! 1 Click the gear on the node Done 2 Then the trash button in the panel footer
Deleting a node. It goes through the node’s own properties panel, not the canvas.

To delete a connection, click the wire, then the round red button on it.

Delete a connection FirstChat MessageNot configured BookedEnd Node 1 Click the wire; it thickens to show it is selected 2 Click the red button at its midpoint
Deleting a connection. It is selected and removed on the canvas, without opening either node.

To delete from the keyboard, click the node or the wire and press Delete.

Nothing asks you to confirm a deletion. Press Ctrl+Z to bring the node or the connection back.

Select Several Nodes#

To move or delete several nodes at once, select them first:

  • Hold Shift, Ctrl or Command and click each node. Click a selected node the same way to take it out of the selection.
  • Hold Shift and drag across empty canvas to draw a box. Every node the box touches is selected.
  • Press Ctrl+A, or Command+A on a Mac, to select every node.

Drag any selected node to move the whole selection. To delete the selection, press Delete or click Delete Nodes; the Start node stays on the canvas. Press Esc, click Clear Selection or click empty canvas to clear the selection.

A properties panel shows one node's settings, so it closes when you select a second node.

Save the Workflow#

Actions → Save Flow writes the workflow as it stands, and it is the only control that saves anything. A node's settings apply to the canvas as you edit them, and Done in the properties panel closes the panel.

One dialog can appear on save: "Saved, but this lead will arrive empty". It names the lead fields nothing in the workflow sets. The workflow is saved either way. See how a lead is captured.

Read the Warning Badges#

Four badges can appear as you draw. None blocks saving:

  • Missing Connections: a port a run can leave by has nothing wired to it.
  • Infinite Loop Detected: the wires contain a cycle. It replaces Missing Connections.
  • Form fields the assistant can read: an End node shares a payload naming a form field, which the assistant can repeat in the chat.
  • Message may never arrive: a message follows a delay of more than 24 hours, which WhatsApp and Instagram refuse.
Missing Connections A run stops at any unconnected dot, Error andAnything else included. Infinite Loop Detected This workflow loops back on itself. A run stopsafter 100 nodes, wherever it has got to, so a loopthat does not end leaves the visitor mid-conversation. Message may never arrive Two-day pause waits more than 24 hours and isfollowed by Check back in. WhatsApp and Instagramrefuse a message that long after the visitor’s lastone. Email and API steps are unaffected. Form fields the assistant can read email, phone in Ask for their details. The assistant can readthese and may repeat them in the chat. Turn off“Let the assistant read this payload” unless thevisitor should hear them back.
The four badges. The first three describe a workflow that will misbehave; the fourth describes one that works exactly as drawn and shares personal data doing it.

Pan and Zoom#

The canvas answers five pointer gestures:

  • Drag empty canvas to pan.
  • Scroll or swipe with two fingers to pan, not zoom.
  • Hold Shift and scroll to pan sideways.
  • Hold Ctrl and scroll to zoom in or out at the pointer.
  • Click empty canvas to clear the selection and close the properties panel.

The palette's magnifier buttons also zoom.

Keyboard Shortcuts#

The canvas answers these keys while you are not typing in a field:

  • Ctrl+Z, or Command+Z on a Mac: undo the last change.
  • Ctrl+Y or Ctrl+Shift+Z, or Shift+Command+Z on a Mac: redo it.
  • Delete or Backspace: delete the selected nodes, or the selected wire.
  • Ctrl+A, or Command+A on a Mac: select every node.
  • Esc: clear the selection.

Common Questions#

Can I Undo a Deletion?#

Yes, until you close the editor. Press Ctrl+Z, or Command+Z on a Mac, and the node comes back with every wire it had. Closing or reloading the editor clears the history. After that, the version you can return to is the one you last saved: close the editor without saving, then open the workflow again.

Why Did My Connection Disappear When I Drew a New One?#

The new wire left from a port that already had one. A port carries a single connection, and the new one replaces the old without asking. Press Ctrl+Z to bring the old wire back, then check the port you dragged from.

Can I Delete the Start Node?#

No. Its properties panel has no delete button and the palette has no Start button, so a workflow keeps one entry point.

Does Moving Nodes Change How the Workflow Runs?#

No. Position is saved so the canvas looks the same when you return, and the engine reads the connections.

Why Is a Port Dot Hollow?#

Hollow means nothing is connected to it. A run that reaches a hollow port ends there, silently, and is recorded as completed.