diff --git a/Webhook-data.md b/Webhook-data.md index 9784057..2854490 100644 --- a/Webhook-data.md +++ b/Webhook-data.md @@ -2,59 +2,340 @@ When a webhook is activated it sends the related information within the POST request body. -## Card creation +## Cards -``` +### Creation + +When a new card is created on board + +```json { - text: '{{wekan-username}} added "{{card-title}}" to "{{list-name}}"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}', - cardId: '{{card-id}}', - listId: '{{list-id}}', - boardId: '{{board-id}}', - user: '{{wekan-username}}', - card: '{{card-title}}', - description: 'act-createCard' + "text": "{{wekan-username}} created card \"{{card-title}}\" to list \"{{list-name}}\" at swimlane \"{{swimlane-name}}\" at board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "listId": "{{list-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "swimlaneId": "{{swimlane-id}}", + "description": "act-createCard" } ``` -## Card archival +### Move -``` +When a card is moved beweteen lists + +```json { - text: '{{wekan-username}} archived "{{card-title}}"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}', - cardId: '{{card-id}}', - listId: '{{list-id}}', - boardId: '{{board-id}}', - user: '{{wekan-username}}', - card: '{{card-title}}', - description: 'act-archivedCard' + "text": "{{wekan-username}} moved card \"{{card-title}}\" at board \"{{board-name}}\" from list \"{{old-list-name}}\" at swimlane \"{{swimlane-name}}\" to list \"{{new-list-name}}\" at swimlane \"{{swimlane-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "listId": "{{new-list-id}}", + "oldListId": "{{old-list-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "swimlaneId": "{{swimlane-id}}", + "description": "act-moveCard" } ``` -## Comment creation +### Archival -``` +A card is moved to archive + +```json { - text: '{{wekan-username}} commented on "{{card-title}}": "{{comment-body}}"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}', - cardId: '{{card-id}}', - boardId: '{{board-id}}', - comment: '{{comment-body}}', - user: '{{wekan-username}}', - card: '{{card-title}}', - description: 'act-addComment' + "text": "{{wekan-username}} Card \"{{card-title}}\" at list \"{{list-name}}\" at swimlane \"{{swimlane-name}}\" at board \"{{board-name}}\" moved to Archive\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "listId": "{{list-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "swimlaneId": "{{swimlane-id}}", + "description": "act-archivedCard" } ``` -## Card move +### Restored -``` +When a card is restored from archive + +```json { - text: '{{wekan-username}} moved "{{card-title}}" from "{{old-list-name}}" to "{{new-list-name}}"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}', - cardId: '{{card-id}}', - listId: '{{new-list-id}}', - oldListId: '{{old-list-id}}', - boardId: '{{board-id}}', - user: '{{wekan-username}}', - card: '{{card-title}}', - description: 'act-moveCard' + "text": "{{wekan-username}} restored card \"{{card-title}}\" to list \"{{list-name}}\" at swimlane \"{{swimlane-name}}\" at board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "listId": "{{list-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "swimlaneId": "{{swimlane-id}}", + "description": "act-restoredCard" } -``` \ No newline at end of file +``` + +## Card content + +Webhooks that are raised on card content change + +### Comment creation + +A user comments the card + +```json +{ + "text": "{{wekan-username}} commented on card \"{{card-title}}\": \"{{comment}}\" at list __list__ at swimlane __swimlane__ at board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "boardId": "{{board-id}}", + "comment": "{{comment}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "commentId": "{{comment-id}}", + "description": "act-addComment" +} +``` + +### AddLabel + +A label is added to card + +```json +{ + "text": "{{wekan-username}} Added label __label__ to card \"{{card-title}}\" at list \"{{list-name}}\" at swimlane \"{{swimlane-name}}\" at board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "listId": "{{list-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "swimlaneId": "{{swimlane-id}}", + "description": "act-addedLabel" +} +``` + +### Join member + +When a member is added to card + +```json +{ + "text": "{{wekan-username}} added member {{wekan-username}} to card \"{{card-title}}\" at list \"{{list-name}}\" at swimlane \"{{swimlane-name}}\" at board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "listId": "{{list-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "swimlaneId": "{{swimlane-id}}", + "description": "act-joinMember" +} +``` + +### Set custom field + +A custom field on card is set + +```json +{ + "text": "{{wekan-username}} act-setCustomField\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "description": "act-setCustomField" +} +``` + +### Add attachment + +```json +{ + "text": "{{wekan-username}} added attachment {{attachment-id}} to card \"{{card-title}}\" at list __list__ at swimlane __swimlane__ at board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "description": "act-addAttachment" +} +``` + +### Delete attachment + +```json +{ + "text": "{{wekan-username}} deleted attachment __attachment__ at card \"{{card-title}}\" at list __list__ at swimlane __swimlane__ at board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "description": "act-deleteAttachment" +} +``` + +### Add checklist + +```json +{ + "text": "{{wekan-username}} added checklist \"{{checklist-name}}\" to card \"{{card-title}}\" at list __list__ at swimlane __swimlane__ at board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "description": "act-addChecklist" +} +``` + +### Remove checklist + +```json +{ + "text": "{{wekan-username}} removed checklist \"{{checklist-name}}\" from card \"{{card-title}}\" at list __list__ at swimlane __swimlane__ at board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "description": "act-removeChecklist" +} +``` + +### Uncomplete checklist + +```json +{ + "text": "{{wekan-username}} uncompleted checklist \"{{checklist-name}}\" at card \"{{card-title}}\" at list __list__ at swimlane __swimlane__ at board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "description": "act-uncompleteChecklist" +} +``` + +### Add checklist item + +```json +{ + "text": "{{wekan-username}} added checklist item {{checklistitem-name}} to checklist \"{{checklist-name}}\" at card \"{{card-title}}\" at list __list__ at swimlane __swimlane__ at board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "description": "act-addChecklistItem" +} +``` + +### Checked item + +```json +{ + "text": "{{wekan-username}} checked {{checklist-name}} of checklist \"{{checklist-name}}\" at card \"{{card-title}}\" at list __list__ at swimlane __swimlane__ at board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "description": "act-checkedItem" +} +``` + +### Removed checklist item + +```json +{ + "text": "{{wekan-username}} act-removedChecklistItem\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}/{{card-id}}", + "cardId": "{{card-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "card": "{{card-title}}", + "description": "act-removedChecklistItem" +} +``` + +## Board + +Webhooks that are raised on board events + +### Create custom field + +```json +{ + "text": "{{wekan-username}} created custom field {{customfield-name}} to card __card__ at list __list__ at swimlane __swimlane__ at board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "description": "act-createCustomField" +} +``` + +## Lists + +Webhooks that are raised on list events + +### Create list + +```json +{ + "text": "{{wekan-username}} added list \"{{list-name}}\" to board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}", + "listId": "{{list-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "description": "act-createList" +} +``` + +### Archived list + +```json +{ + "text": "{{wekan-username}} List \"{{list-name}}\" at swimlane __swimlane__ at board \"{{board-name}}\" moved to Archive\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}", + "listId": "{{list-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "description": "act-archivedList" +} +``` + +### Remove list + +```json +{ + "text": "{{wekan-username}} act-removeList\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}", + "listId": "{{list-id}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "description": "act-removeList" +} +``` + +## Swimlane + +### Create swimlane + +```json +{ + "text": "{{wekan-username}} created swimlane \"{{swimlane-name}}\" to board \"{{board-name}}\"\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "swimlaneId": "{{swimlane-id}}", + "description": "act-createSwimlane" +} +``` + +### Archived swimlane + +```json +{ + "text": "{{wekan-username}} Swimlane \"{{swimlane-name}}\" at board \"{{board-name}}\" moved to Archive\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "swimlaneId": "{{swimlane-id}", + "description": "act-archivedSwimlane" +} +``` + +### Remove swimlane + +```json +{ + "text": "{{wekan-username}} act-removeSwimlane\nhttp://{{wekan-host}}/b/{{board-id}}/{{board-name}}", + "boardId": "{{board-id}}", + "user": "{{wekan-username}}", + "swimlaneId": "{{swimlane-id}", + "description": "act-removeSwimlane" +} +```