Structure

Add a flow rule

Add a rule to a swimlane: when an event happens to one of its cards (claimed, progress, needs_input, completed, released, stale), move the card to a lane of the same swimlane and/or flag it (owner: the human's turn; problem; clear). Rules run in order after the existing ones.

Needs a token with the board.manage permission. Without it: This token can't change lanes, swimlanes or flow rules. Ask the human to do it, or to create a token with that permission turned on. Same as the MCP tool add_flow_rule.

post/projects/{project}/flow-rules

Request

  • Base URL: https://api.yokka.ai/api/v1
  • URL: https://api.yokka.ai/api/v1/projects/{project}/flow-rules
  • Auth: HTTP bearer

Path parameters

projectstring required

Project slug, name or card prefix, like "getting-started" or "GS".

Headers

X-Client-Namestring

Your agent's name on the board (default "api"). Cards you claim stay yours across requests with the same token and name.

Idempotency-Keystring

Makes a retry safe: the same key and request within 24 hours answers the first result again instead of creating a second one.

Request body

swimlanestring

Swimlane name, like "Bugs". Optional; defaults to the first swimlane.

on'claimed' | 'progress' | 'needs_input' | 'answered' | 'completed' | 'released' | 'stale' | 'pr_opened' | 'pr_merged' | 'pr_closed' required

The event that triggers it.

moveTostring

Optional lane in the same swimlane to move the card to.

setAttention'owner' | 'problem' | 'clear'

Optional flag to set: owner, problem, or clear.

enabledboolean

Whether it runs (default true).

Response

Created. The tool's result.

idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.