From 1593e0212ec966b37e91de7a73387ffc4e3a0fa8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= <joerg@thalheim.io>
Date: Sat, 30 Oct 2021 09:35:01 +0200
Subject: [PATCH] docs: document github webhooks

---
 doc/manual/src/SUMMARY.md  |  1 +
 doc/manual/src/webhooks.md | 13 +++++++++++++
 2 files changed, 14 insertions(+)
 create mode 100644 doc/manual/src/webhooks.md

diff --git a/doc/manual/src/SUMMARY.md b/doc/manual/src/SUMMARY.md
index b315aeff..80e73112 100644
--- a/doc/manual/src/SUMMARY.md
+++ b/doc/manual/src/SUMMARY.md
@@ -8,6 +8,7 @@
 - [Plugins](./plugins/README.md)
   - [Declarative Projects](./plugins/declarative-projects.md)
 - [Using the external API](api.md)
+- [Webhooks](webhooks.md)
 - [Monitoring Hydra](./monitoring/README.md)
 
 ## Developer's Guide
diff --git a/doc/manual/src/webhooks.md b/doc/manual/src/webhooks.md
new file mode 100644
index 00000000..2b26cd61
--- /dev/null
+++ b/doc/manual/src/webhooks.md
@@ -0,0 +1,13 @@
+# Webhooks
+
+Hydra can be notified by github's webhook to trigger a new evaluation when a
+jobset has a github repo in its input.
+To set up a github webhook go to `https://github.com/<yourhandle>/<yourrepo>/settings` and in the `Webhooks` tab
+click on `Add webhook`.
+
+- In `Payload URL` fill in `https://<your-hydra-domain>/api/push-github`.
+- In `Content type` switch to `application/json`.
+- The `Secret` field can stay empty.
+- For `Which events would you like to trigger this webhook?` keep the default option for events on `Just the push event.`.
+
+Then add the hook with `Add webhook`.