summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFrédéric Guillot <fguillot@users.noreply.github.com>2014-05-03 08:46:27 -0400
committerFrédéric Guillot <fguillot@users.noreply.github.com>2014-05-03 08:46:27 -0400
commit5d061594486c0d5761ac80a7548fdb4fdad0619b (patch)
treed2b41f57705c53d0b94724ced2c6cb9b826ee913 /docs
parente2d658b396d8bd1f60261924c05a0c6481647c14 (diff)
Improve webhooks documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/webhooks.markdown24
1 files changed, 23 insertions, 1 deletions
diff --git a/docs/webhooks.markdown b/docs/webhooks.markdown
index bcd38f0f..fb5335f4 100644
--- a/docs/webhooks.markdown
+++ b/docs/webhooks.markdown
@@ -6,7 +6,7 @@ Webhooks are useful to perform actions from external applications (shell-scripts
How to create a task with a webhook?
------------------------------------
-Firstly, you have to get the token from the preferences page. After that, just call this url from anywhere:
+Firstly, you have to get the token from the settings page. After that, just call this url from anywhere:
```bash
# Create a task for the default project inside the first column
@@ -15,3 +15,25 @@ curl "http://myserver/?controller=task&action=add&token=superSecretToken&title=m
# Create a task to another project inside a specific column with the color red
curl "http://myserver/?controller=task&action=add&token=superSecretToken&title=task123&project_id=3&column_id=7&color_id=red"
```
+
+Available responses
+-------------------
+
+- When a task is created successfully, Kanboard return the message "OK" in plain text.
+- However if the task creation fail, you will got a "FAILED" message.
+- If the token is wrong, you got a "Not Authorized" message and a HTTP status code 401.
+
+Available parameters
+--------------------
+
+Base url: `http://YOUR_SERVER_HOSTNAME/?controller=task&action=add`
+
+- `token`: Token displayed on the settings page (required)
+- `title`: Task title (required)
+- `description`: Task description
+- `color_id`: Supported colors are yellow, blue, green, purple, red, orange and grey
+- `project_id`: Project id (Get the id from the projects page, mouse over on the project title)
+- `owner_id`: Assignee (Get the user id from the users page, mouse over on the username)
+- `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.