diff options
| author | Shyam Sunder <sgsunder1@gmail.com> | 2020-08-13 19:14:14 -0400 |
|---|---|---|
| committer | Shyam Sunder <sgsunder1@gmail.com> | 2020-08-13 22:41:43 -0400 |
| commit | 4595f9a2aa1d39f815a62cff2328bc61b0f1a9ed (patch) | |
| tree | 05e38146d72863d75e20b91e4588d55f54a446a6 /doc | |
| parent | b74492974df42cc40be0221b7d08ffa0819dba46 (diff) | |
server: API support for webhooks
Closes #339
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/API.md | 10 |
1 files changed, 10 insertions, 0 deletions
@@ -13,6 +13,7 @@ - [Error handling](#error-handling) - [Field selecting](#field-selecting) - [Versioning](#versioning) + - [Webhooks](#webhooks) 2. [API reference](#api-reference) @@ -276,6 +277,15 @@ reject the request as well, in which case the client is encouraged to notify the user about the situation. +## Webhooks + +System administrators can choose to configure webhooks to track events. +Webhook URIs can be configured in `config.yaml` (See `config.yaml.dist` for +example). Upon any event, the API will send a `POST` request to the listed +URIs with a [snapshot resource](#snapshot) generated with anonymous user +privileges as the message body, in JSON format. + + # API reference Depending on the deployment, the URLs might be relative to some base path such |