WeKan Rules API
The Rules API from WeKan — 2 operation(s) for rules.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/wekan:wekan-rules-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Wekan Rules API
version: '1.0'
description: 'Operations tagged Rules across 2 of this provider''s published API definitions: wekan-meteor3-openapi.yml, wekan-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Rules
paths:
/api/boards/{board}/rules:
get:
operationId: get_board_rules
summary: Get the list of automation rules of a board
tags:
- Rules
parameters:
- name: board
in: path
description: 'the board ID
'
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
content:
application/json:
schema:
type: array
items:
type: object
properties:
_id:
type: string
title:
type: string
trigger:
type: object
action:
type: object
post:
operationId: new_board_rule
summary: Add an automation rule to a board
description: 'The trigger and action are embedded inline. See the Rules
documentation for the available trigger activityTypes and action actionTypes.
Trigger matching fields that are omitted (e.g. userId, listName,
swimlaneName, cardTitle) default to the ''*'' wildcard, so e.g. issue #2674''s
"remove a member when a card is moved away from a list" only needs
trigger {activityType: ''moveCard'', oldListName: ''...''} and
action {actionType: ''removeMember'', username: ''...''}.'
tags:
- Rules
parameters:
- name: board
in: path
description: 'the board ID
'
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
content:
application/json:
schema:
type: object
properties:
_id:
type: string
triggerId:
type: string
actionId:
type: string
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
title:
type: string
description: 'the rule title
'
trigger:
type: object
description: 'the trigger document (must include activityType)
'
action:
type: object
description: 'the action document (must include actionType)
'
required:
- title
- trigger
- action
application/json:
schema:
type: object
properties:
title:
type: string
description: 'the rule title
'
trigger:
type: object
description: 'the trigger document (must include activityType)
'
action:
type: object
description: 'the action document (must include actionType)
'
required:
- title
- trigger
- action
/api/boards/{board}/rules/{rule}:
get:
operationId: get_board_rule
summary: Get a single automation rule
tags:
- Rules
parameters:
- name: board
in: path
description: 'the board ID
'
required: true
schema:
type: string
- name: rule
in: path
description: 'the rule ID
'
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
content:
application/json:
schema:
type: object
properties:
_id:
type: string
title:
type: string
trigger:
type: object
action:
type: object
put:
operationId: edit_board_rule
summary: Edit an automation rule
description: 'Any of title, trigger and action may be supplied; the trigger
and action documents are replaced ($set) when present. A supplied trigger
that includes an activityType gets its missing matching fields defaulted
to the ''*'' wildcard, like on creation.'
tags:
- Rules
parameters:
- name: board
in: path
description: 'the board ID
'
required: true
schema:
type: string
- name: rule
in: path
description: 'the rule ID
'
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
content:
application/json:
schema:
type: object
properties:
_id:
type: string
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
title:
type: string
description: 'the new rule title
'
trigger:
type: object
description: 'the new trigger document
'
action:
type: object
description: 'the new action document
'
application/json:
schema:
type: object
properties:
title:
type: string
description: 'the new rule title
'
trigger:
type: object
description: 'the new trigger document
'
action:
type: object
description: 'the new action document
'
delete:
operationId: delete_board_rule
summary: Remove an automation rule (and its trigger and action)
tags:
- Rules
parameters:
- name: board
in: path
description: 'the board ID
'
required: true
schema:
type: string
- name: rule
in: path
description: 'the rule ID
'
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
content:
application/json:
schema:
type: object
properties:
_id:
type: string
components:
securitySchemes:
UserSecurity:
type: apiKey
in: header
name: Authorization
x-refined-from:
- wekan-meteor3-openapi.yml
- wekan-openapi.yml