Adding webhooks section to README

RaspberryPiFoundation · Feb 9, 2023 · 1807fa5 · 1807fa5
1 parent 1d5707d
commit 1807fa5
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -39,3 +39,8 @@ Add a comma separated list to the relevant enviroment settings. E.g for developm
 
 ```
 ALLOWED_ORIGINS=localhost:3002,localhost:3000
+```
+
+# Webhooks
+
+This API receives push event data from the [Raspberry Pi Learning](https://github.com/raspberrypilearning) organisation via webhooks. These webhooks are mediated locally through `smee`, which runs in a Docker container. The webhook data is processed using the `github_webhooks` gem in the `github_webhooks_controller`.