Andreas/wekan
1
0
Fork 0
mirror of https://github.com/wekan/wekan.git synced 2025-12-16 07:20:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

This explains the webhooks tested in #1263

Andrés 2017-10-01 21:42:58 -03:00
parent 4b6b0e68ca
commit 0d04c6fe03
1 changed files with 60 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

60
Webhook-data.md Normal file

@ -0,0 +1,60 @@
# Webhook data
When a webhook is activated it sends the related information within the POST request body.
## Card creation
```
{
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'
}
```
## Card archival
```
{
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'
}
```
## Comment creation
```
{
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'
}
```
## Card move
```
{
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'
}
```