Kaiten External Webhooks
You can use webhooks to notify your app or web application about certain events occured in spaces with activated external webhook. For example, you want to alert your application when card in particular space is updated or a comment to card is added. By using webhooks you can make fewer API calls and make sure your apps are more efficient.
Webhook installation
Creating a webhook is a two-step process. First you have to activate webhook in Kaiten(you can set up different webhooks for each space), and after that you have to set up your server to receive and manage the payload.To activate webhook in particular space in Kaiten go tospace setting,chooseexternal webhooksin Menu and type your URL, that will receive the webhookPOSTrequests. To register a webhook click create. By default newly created webhook is active, but you can always turn it off in menu.
Once installed, the webhook notification will be triggered each time available events occur. This notification contains a JSON payload.
The structure is simple and clear:
add events
{
"event": action,
"data": {
"author": {...},
... // model keys, see examples below
},
}update events
{
"event": action,
"data": {
"old": {...},
"changes": {...},
"author": {...}
}
}remove events
{
"event": action,
"data": {
"author": {...},
... // model keys, see examples below
}
}So far we support actions belonging to Spaces, Boards, Cards, Blocks, Comments, Time Logs, Tags, Files.
