Mirrors/wg-portal
1
0
Fork 0
mirror of https://github.com/h44z/wg-portal.git synced 2025-10-04 23:46:18 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

add webhook docs (#444)

Browse Source
This commit is contained in:
Christoph
2025-06-27 12:02:16 +02:00
parent 3c72a26e91
commit 1d7dd26290
3 changed files with 90 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/documentation/configuration/overview.md
View File

@@ -669,7 +669,7 @@ The webhook section allows you to configure a webhook that is called on certain
A JSON object is sent in a POST request to the webhook URL with the following structure:
```json
{
"event": "peer_created",
"event": "update",
"entity": "peer",
"identifier": "the-peer-identifier",
"payload": {
@@ -679,6 +679,8 @@ A JSON object is sent in a POST request to the webhook URL with the following st
}
```
Further details can be found in the [usage documentation](../usage/webhooks.md).
### `url`
- **Default:** *(empty)*
- **Description:** The POST endpoint to which the webhook is sent. The URL must be reachable from the WireGuard Portal server. If the URL is empty, the webhook is disabled.