diff options
| author | Matt Humphrey <matt@tomatto.co.uk> | 2013-03-06 14:33:32 +0400 |
|---|---|---|
| committer | Matt Humphrey <matt@tomatto.co.uk> | 2013-03-06 19:15:26 +0400 |
| commit | 1dd712ddc238d2e6c30be09cb071c8e9b60cfcac (patch) | |
| tree | 2949939acfd0355612e6f91be2936aa462904e6f /doc/api/system_hooks.md | |
| parent | d03af842c5ea0fdc40e709e9b3104c4d723828ab (diff) | |
System hooks API.
Diffstat (limited to 'doc/api/system_hooks.md')
| -rw-r--r-- | doc/api/system_hooks.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/api/system_hooks.md b/doc/api/system_hooks.md new file mode 100644 index 00000000000..f6e11ed238e --- /dev/null +++ b/doc/api/system_hooks.md @@ -0,0 +1,47 @@ +All methods require admin authorization.
+
+## List system hooks
+
+Get list of system hooks
+
+```
+GET /hooks
+```
+
+Will return hooks with status `200 OK` on success, or `404 Not found` on fail.
+
+## Add new system hook hook
+
+```
+POST /hooks
+```
+
+Parameters:
+
++ `url` (required) - The hook URL
+
+Will return status `201 Created` on success, or `404 Not found` on fail.
+
+## Test system hook
+
+```
+GET /hooks/:id
+```
+
+Parameters:
+
++ `id` (required) - The ID of hook
+
+Will return hook with status `200 OK` on success, or `404 Not found` on fail.
+
+## Delete system hook
+
+```
+DELETE /hooks/:id
+```
+
+Parameters:
+
++ `id` (required) - The ID of hook
+
+Will return status `200 OK` on success, or `404 Not found` on fail.
\ No newline at end of file |