32f1eaaf0f
* updated system hooks documentation and code comments * fixed access to system hooks if no user given resulting in a `500 Server Error` * added tests
50 lines
644 B
Markdown
50 lines
644 B
Markdown
All methods require admin authorization.
|
|
|
|
## List system hooks
|
|
|
|
Get list of system hooks
|
|
|
|
```
|
|
GET /hooks
|
|
```
|
|
|
|
Parameters:
|
|
|
|
+ **none**
|
|
|
|
|
|
## Add new system hook hook
|
|
|
|
```
|
|
POST /hooks
|
|
```
|
|
|
|
Parameters:
|
|
|
|
+ `url` (required) - The hook URL
|
|
|
|
|
|
## Test system hook
|
|
|
|
```
|
|
GET /hooks/:id
|
|
```
|
|
|
|
Parameters:
|
|
|
|
+ `id` (required) - The ID of hook
|
|
|
|
|
|
## Delete system hook
|
|
|
|
Deletes a system hook. This is an idempotent API function and returns `200 Ok` even if the hook
|
|
is not available. If the hook is deleted it is also returned as JSON.
|
|
|
|
```
|
|
DELETE /hooks/:id
|
|
```
|
|
|
|
Parameters:
|
|
|
|
+ `id` (required) - The ID of hook
|