change GET to POST, removed /health

README.md

@@ -6,9 +6,9 @@ It's designed to be run as a Docker container and integrated with Traefik v3 for
 
 ## Features
 
-*   Receives POST requests on `/flic-webhook`.
+*   Receives GET requests on `/flic-webhook`.
 *   Uses HTTP headers `Button-Name` and `Timestamp` from the Flic request.
-*   Parses `click_type` from the Flic request body.
+*   Gets `click_type` from query parameter.
 *   Looks up the target PWA push subscription based on the `Button-Name` header in a JSON file.
 *   Sends a Web Push notification containing the click details (action, button, timestamp) to the corresponding PWA subscription.
 *   Integrates with Traefik v3 via Docker labels.
@@ -87,7 +87,7 @@ It's designed to be run as a Docker container and integrated with Traefik v3 for
     *   Add entries mapping your Flic button's serial number (as a lowercase string key) to the PWA `PushSubscription` object.
         ```json
         {
-          "80:e4:da:70:xx:xx:xx:xx": { // <-- Replace with your actual Flic Button Serial (lowercase recommended)
+          "game": { // <-- Replace with your actual Flic Button name (lowercase recommended)
             "endpoint": "https://your_pwa_push_endpoint...",
             "expirationTime": null,
             "keys": {
@@ -119,11 +119,6 @@ It's designed to be run as a Docker container and integrated with Traefik v3 for
       --mount type=bind,src=./subscriptions.json,dst=/app/subscriptions.json \
       flic-webhook-webpush:latest
     ```
-    *   `--network traefik`: Connects to the Traefik network.
-    *   `--env-file .env`: Loads configuration from your `.env` file.
-    *   `--label-file labels`: Applies the Traefik routing rules from your edited `labels` file.
-    *   `--mount ...`: Makes your local `subscriptions.json` available inside the container at `/app/subscriptions.json`. `readonly` is recommended as the app only reads it.
-    *   `flic-webhook-webpush:latest`: The image built in the previous step.
 
 3.  **Check Logs:**
     Monitor the container logs to ensure it started correctly and to see incoming webhook requests or errors.
@@ -141,18 +136,11 @@ In your Flic app or Flic Hub SDK interface:
 1.  Select your Flic button.
 2.  Add an "Internet Request" action.
 3.  Fill in the following details:
-    *   Set `POST` method.
-    *   Set URL: `https://webpush.virtonline.eu/flic-webhook`
+    *   Set `GET` method.
+    *   Set URL with query parameter: `https://webpush.virtonline.eu/flic-webhook?click_type=SingleClick`
     *   Add headers:
         *   Key: `Authorization`
         *   Value: `Bearer <FLIC_SECRET>` (Replace `<FLIC_SECRET>` with the actual secret from your `.env` file).
-    *  **Body:** Configure the JSON body to include the click type.
-    ```json
-    {
-        "click_type": "SingleClick"
-    }
-    ```
-    *   Set Content-Type: `application/json`.
     *   It should look like this:
 
     <!-- <img src="images/flic-button-request.png" width="300" alt="Flic Button Request Configuration"> // TODO: Update image -->
@@ -162,33 +150,19 @@ In your Flic app or Flic Hub SDK interface:
     
 ## API Endpoint
 
-*   **`POST /flic-webhook`**
+*   **`GET /flic-webhook`**
     *   **Description:** Receives Flic button events.
     *   **Authentication:** Optional Bearer token via `Authorization` header if `FLIC_SECRET` is configured.
-    *   **Request Body (JSON):**
-        ```json
-        {
-          "click_type": "SingleClick | DoubleClick | Hold"
-        }
-        ```
+    *   **Query Parameters:**
+        *   `click_type`: The type of button press (SingleClick, DoubleClick, or Hold)
     *   **Responses:**
         *   `200 OK`: Webhook received, push notification sent successfully.
-        *   `400 Bad Request`: Missing `Button-Name` header or `click_type` in the request body.
+        *   `400 Bad Request`: Missing `Button-Name` header or `click_type` query parameter.
         *   `401 Unauthorized`: Missing or invalid Bearer token (if `FLIC_SECRET` is enabled).
         *   `404 Not Found`: No subscription found in `subscriptions.json` for the given `Button-Name`.
         *   `410 Gone`: The push subscription associated with the button was rejected by the push service (likely expired or revoked).
         *   `500 Internal Server Error`: Failed to send the push notification for other reasons.
 
-*   **`GET /health`** (Optional)
-    *   **Description:** Simple health check endpoint.
-    *   **Response:**
-        ```json
-        {
-          "status": "UP",
-          "timestamp": "ISO_8601_TIMESTAMP_STRING"
-        }
-        ```
-
 ## Testing the Webhook
 
 Once your service is up and running, you can test the webhook endpoint using curl or any API testing tool:
@@ -196,14 +170,10 @@ Once your service is up and running, you can test the webhook endpoint using cur
 **Note:** In the command below, replace `a74181969a613c545d66c1e436e75c1e4a6` with your actual FLIC_SECRET value from your .env file.
 
 ```bash
-curl -X POST https://webpush.virtonline.eu/flic-webhook \
+curl -X GET "https://webpush.virtonline.eu/flic-webhook?click_type=SingleClick" \
   -H "Authorization: Bearer a74181969a613c545d66c1e436e75c1e4a6" \
-  -H "Content-Type: application/json" \
   -H "Button-Name: Game" \
-  -H "Timestamp: 2025-03-26T01:10:20Z" \
-  -d '{
-  "click_type": "SingleClick"
-}'
+  -H "Timestamp: 2025-03-26T01:10:20Z"
 ```
 
 The expected response should be: