Webhook subscriptions

.github/raidhub-services-version.env

@@ -1,2 +1,2 @@
 RAIDHUB_SERVICES_REPO=Raid-Hub/RaidHub-Services
-RAIDHUB_SERVICES_COMMIT=858b76cf0314c1d5547a60011bf444eb63615e88
+RAIDHUB_SERVICES_COMMIT=0e6bf77f6ee4e84c9d0adc6190358b918fdf3626

README.md

@@ -21,8 +21,11 @@ Note: you will need to clone the [RaidHub-Services](https://github.com/Raid-Hub/
 ### Turning the API On
 
 1. Run `cp example.env .env` and make any changes
-2. Run `bun dev`
-3. By default the API is available at `http://localhost:8000`
+2. Copy `api-keys.example.json` to `api-keys.json` and set at least one `key` (use `origin` `"*"` for local tools such as **raidhub-discord**). Point `API_KEYS_PATH` in `.env` at that file (defaults to `./api-keys.json`).
+3. Run `bun dev`
+4. By default the API is available at `http://localhost:8000`
+
+With `PROD=true`, every request must include a valid `x-api-key` header matching an entry in `api-keys.json`.
 
 ### Open API
 

api-keys.example.json

@@ -0,0 +1,7 @@
+[
+  {
+    "description": "Copy to api-keys.json and set unique keys. origin * allows any Origin header.",
+    "origin": "*",
+    "key": "00000000-0000-4000-8000-000000000001"
+  }
+]

example.env

@@ -11,6 +11,9 @@ CLIENT_SECRET=123abc
 ADMIN_CLIENT_SECRET=abc123
 JWT_SECRET=secretkey
 
+# When PROD=true, clients must send x-api-key matching an entry here (copy to api-keys.json).
+API_KEYS_PATH=./api-keys.json
+
 RABBIT_API_USER=guest
 RABBIT_API_PASSWORD=guest
 
@@ -24,4 +27,9 @@ SENTRY_DSN=""
 SENTRY_ENVIRONMENT="development"
 
 # Logging
-LOG_LEVEL="info"
+LOG_LEVEL="info"
+
+# Integration
+DISCORD_PUBLIC_KEY=""
+DISCORD_BOT_TOKEN=""
+DISCORD_APPLICATION_ID=""