docs/Features/IFTTT/IFTTT.md
WeKan Rules ("if this then that") automate your board: when something happens (a trigger), WeKan runs an action.
See the full, up-to-date reference at Features / Rules — this page is a quick overview. The Rules page is now a fullscreen page (board sidebar → Rules), not a popup, and adds selecting, editing, import/export, a visual Workflow view, scheduled rules, and a REST API.
When … → Then …, grouped by trigger).automationRules.Currently, there are three types of triggers: board, card and checklist
| Board | Card | Checklist |
|---|---|---|
| create card | added/removed label, attachment, person | checklist added/removed |
| card moved to | check item checked/unchecked | |
| card moved from | checklist completed |
For every trigger, there are 4 types of actions: board, card, checklist and mail
| Board | Card | Checklist | |
|---|---|---|---|
| move card to list | add/remove label, attachment, person | checklist add/remove | send email to |
| move to top/bottom | set title/description | check/uncheck item | |
| archive/unarchive | checklist complete |
Rules can be added, edited and removed over the REST API. The trigger and action are embedded inline so each rule is self-contained.
| Method | Path | Purpose |
|---|---|---|
GET | /api/boards/:boardId/rules | list rules |
GET | /api/boards/:boardId/rules/:ruleId | get one rule |
POST | /api/boards/:boardId/rules | add a rule |
PUT | /api/boards/:boardId/rules/:ruleId | edit a rule (title / trigger / action) |
DELETE | /api/boards/:boardId/rules/:ruleId | remove a rule (and its trigger + action) |
POST / PUT body:
{
"title": "Archive after 90 days",
"trigger": { "activityType": "scheduledTrigger", "scheduleKind": "aging",
"listName": "Completed", "days": 90, "atTime": "03:00" },
"action": { "actionType": "archive" }
}
Python helper (api.py):
python3 api.py listrules BOARDID
python3 api.py addrule BOARDID 'On create -> top' \
'{"activityType":"createCard","listName":"*","swimlaneName":"*","cardTitle":"*","userId":"*"}' \
'{"actionType":"moveCardToTop","listName":"*","swimlaneName":"*"}'
python3 api.py editrule BOARDID RULEID '{"title":"New title"}'
python3 api.py removerule BOARDID RULEID
See Features / Rules for the full list of trigger
activityTypes and action actionTypes, scheduled rules, buttons, the visual
Workflow view, and Trello/Jira import.