summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/webhooks.markdown323
1 files changed, 263 insertions, 60 deletions
diff --git a/docs/webhooks.markdown b/docs/webhooks.markdown
index 6627e3af..fa3e11d8 100644
--- a/docs/webhooks.markdown
+++ b/docs/webhooks.markdown
@@ -3,8 +3,269 @@ Webhooks
Webhooks are useful to perform actions with external applications.
-- Webhooks can be used to create a task by calling a simple URL (You can also do that by using the API)
-- An external URL can be called automatically when a task is created or modified
+- Webhooks can be used to create a task by calling a simple URL (You can also do that with the API)
+- An external URL can be called automatically when an event occurs in Kanboard (task creation, comment updated, etc)
+
+How to write a webhook receiver?
+--------------------------------
+
+All internal events of Kanboard can be sent to an external URL.
+
+- The webhook url have to be defined in **Settings > Webhooks > Webhook URL**.
+- When an event is triggered Kanboard call automatically the predefined URL
+- The data are encoded in JSON format and sent with a POST HTTP request
+- The webhook token is also sent as a query string parameter, so you can check if the request really come from Kanboard.
+- **Your custom URL must answer in less than 1 second**, those requests are synchronous (PHP limitation) and that can slow down the user interface if your script is too slow!
+
+### List of supported events
+
+- comment.create
+- comment.update
+- file.create
+- task.move.project
+- task.move.column
+- task.move.position
+- task.move.swimlane
+- task.update
+- task.create
+- task.close
+- task.open
+- task.assignee_change
+- subtask.update
+- subtask.create
+
+### Example of HTTP request
+
+```
+POST https://your_webhook_url/?token=WEBHOOK_TOKEN_HERE
+User-Agent: Kanboard Webhook
+Content-Type: application/json
+Connection: close
+
+{
+ "event_name": "task.move.column",
+ "event_data": {
+ "task_id": "1",
+ "project_id": "1",
+ "position": 1,
+ "column_id": "1",
+ "swimlane_id": "0",
+ "src_column_id": "2",
+ "dst_column_id": "1",
+ "date_moved": "1431991532",
+ "recurrence_status": "0",
+ "recurrence_trigger": "0"
+ }
+}
+```
+
+All event payloads are in the following format:
+
+```json
+{
+ "event_name": "model.event_name",
+ "event_data": {
+ "key1": "value1",
+ "key2": "value2",
+ ...
+ }
+}
+```
+
+The `event_data` values are not necessary normalized across events.
+
+### Examples of event payloads
+
+Task creation:
+
+```json
+{
+ "event_name": "task.create",
+ "event_data": {
+ "title": "Demo",
+ "description": "",
+ "project_id": "1",
+ "owner_id": "1",
+ "category_id": 0,
+ "swimlane_id": 0,
+ "column_id": "2",
+ "color_id": "yellow",
+ "score": 0,
+ "time_estimated": 0,
+ "date_due": 0,
+ "creator_id": 1,
+ "date_creation": 1431991532,
+ "date_modification": 1431991532,
+ "date_moved": 1431991532,
+ "position": 1,
+ "task_id": 1
+ }
+}
+```
+
+Task modification:
+
+```json
+{
+ "event_name": "task.update",
+ "event_data": {
+ "id": "1",
+ "title": "Demo",
+ "description": "",
+ "date_creation": "1431991532",
+ "color_id": "yellow",
+ "project_id": "1",
+ "column_id": "1",
+ "owner_id": "1",
+ "position": "1",
+ "is_active": "1",
+ "date_completed": null,
+ "score": "0",
+ "date_due": "0",
+ "category_id": "0",
+ "creator_id": "1",
+ "date_modification": 1431991603,
+ "reference": "",
+ "date_started": 1431993600,
+ "time_spent": 0,
+ "time_estimated": 0,
+ "swimlane_id": "0",
+ "date_moved": "1431991572",
+ "recurrence_status": "0",
+ "recurrence_trigger": "0",
+ "recurrence_factor": "0",
+ "recurrence_timeframe": "0",
+ "recurrence_basedate": "0",
+ "recurrence_parent": null,
+ "recurrence_child": null,
+ "task_id": "1"
+ }
+}
+```
+
+Move a task to another column:
+
+```json
+{
+ "event_name": "task.move.column",
+ "event_data": {
+ "task_id": "1",
+ "project_id": "1",
+ "position": 1,
+ "column_id": "1",
+ "swimlane_id": "0",
+ "src_column_id": "2",
+ "dst_column_id": "1",
+ "date_moved": "1431991532",
+ "recurrence_status": "0",
+ "recurrence_trigger": "0"
+ }
+}
+```
+
+Move a task to another position:
+
+```json
+{
+ "event_name": "task.move.position",
+ "event_data": {
+ "task_id": "2",
+ "project_id": "1",
+ "position": 1,
+ "column_id": "1",
+ "swimlane_id": "0",
+ "src_column_id": "1",
+ "dst_column_id": "1",
+ "date_moved": "1431996905",
+ "recurrence_status": "0",
+ "recurrence_trigger": "0"
+ }
+}
+```
+
+Comment creation:
+
+```json
+{
+ "event_name": "comment.create",
+ "event_data": {
+ "id": 1,
+ "task_id": "1",
+ "user_id": "1",
+ "comment": "test",
+ "date": 1431991615
+ }
+}
+```
+
+Comment modification:
+
+```
+{
+ "event_name": "comment.update",
+ "event_data": {
+ "id": "1",
+ "task_id": "1",
+ "user_id": "1",
+ "comment": "test edit"
+ }
+}
+```
+
+Subtask creation:
+
+```json
+{
+ "event_name": "subtask.create",
+ "event_data": {
+ "id": 3,
+ "task_id": "1",
+ "title": "Test",
+ "user_id": "1",
+ "time_estimated": "2",
+ "position": 3
+ }
+}
+```
+
+Subtask modification:
+
+```json
+{
+ "event_name": "subtask.update",
+ "event_data": {
+ "id": "1",
+ "status": 1,
+ "task_id": "1"
+ }
+}
+```
+
+File upload:
+
+```json
+{
+ "event_name": "file.create",
+ "event_data": {
+ "task_id": "1",
+ "name": "test.png"
+ }
+}
+```
+
+Screenshot created:
+
+```json
+{
+ "event_name": "file.create",
+ "event_data": {
+ "task_id": "2",
+ "name": "Screenshot taken May 19, 2015 at 10:56 AM"
+ }
+}
+```
+
+Note: Webhooks configuration and payload have changed since Kanboard >= 1.0.15
How to create a task with a webhook?
------------------------------------
@@ -38,61 +299,3 @@ Base URL: `http://YOUR_SERVER_HOSTNAME/?controller=webhook&action=task`
- `column_id`: Column on the board (Get the column id from the projects page, mouse over on the column name)
Only the token and the title parameters are mandatory. The different id can also be found in the database.
-
-How to call an external URL when a task is created or updated?
---------------------------------------------------------------
-
-- There is two events available: **task creation** and **task modification**
-- External URLs can be defined on the settings page
-- When an event is triggered Kanboard call automatically the predefined URL
-- The task data encoded in JSON is sent with a POST HTTP request
-- The webhook token is also sent as a query string parameter, so you can check if the request is not usurped, it's also better if you use HTTPS.
-- **Your custom URL must answer in less than 1 second**, those requests are synchronous (PHP limitation) and that can slow down the application if your script is too slow!
-
-### Quick example with PHP
-
-Start by creating a basic PHP script `index.php`:
-
-```php
-<?php
-
-$body = file_get_contents('php://input');
-file_put_contents('/tmp/webhook', $body);
-```
-
-This script dump the task data to the file `/tmp/webhook`.
-
-Now run a webserver from the command line:
-
-```bash
-php -S 127.0.0.1:8081
-```
-
-After that, go the settings page of Kanboard, enter the right URL here `http://127.0.0.1:8081/`.
-And finally, create a task and you should see the JSON payload in the file.
-
-```javascript
-{
- "task_id":"2",
- "title":"boo",
- "description":"",
- "project_id":"1",
- "owner_id":"0",
- "category_id":"0",
- "column_id":"2",
- "color_id":"yellow",
- "score":0,
- "date_due":0,
- "creator_id":1,
- "date_creation":1405981280,
- "position":0
-}
-```
-
-For our example, Kanboard use this request to call your program:
-
-```
-POST http:://127.0.0.1:8081/?token=RANDOM_TOKEN_HERE
-
-{... JSON payload ...}
-``` \ No newline at end of file
generated by cgit v1.2.3 (git 2.46.0) at 2024-11-23 20:23:48 +0000