Compare commits
1 Commits
f614e67e8b
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 52b19701cb |
17
README.md
17
README.md
@@ -114,11 +114,11 @@ In your Flic app or Flic Hub SDK interface:
|
|||||||
2. Add an "Internet Request" action.
|
2. Add an "Internet Request" action.
|
||||||
3. Fill in the following details:
|
3. Fill in the following details:
|
||||||
* Select the `GET` method.
|
* Select the `GET` method.
|
||||||
* Set URL with query parameter: `https://<your_domain>/webhook/SingleClick` (Replace `<your_domain>` with your actual service domain, e.g., `webpush.virtonline.eu`).
|
* Set URL with query parameter: `https://webpush.virtonline.eu/webhook/SingleClick`
|
||||||
* **If Basic Authentication is enabled:**
|
* **If Basic Authentication is enabled:**
|
||||||
* Set the Headers:
|
* Set the Headers:
|
||||||
* Set the `Key` fields to `Authorization`.
|
* Set the `Key` fields to `Authorization`.
|
||||||
* Set the `Value` fields to `Basic <base64 encoded username:password>`.
|
* Set the `Value` fields to `Basic <base64 encoded username:password>` (e.g., `Basic dXNlcm5hbWU6cGFzc3dvcmQ=`). Use `$(echo -n 'user:password' | base64)` to generate the base64 encoded string.
|
||||||
* Click `ADD`.
|
* Click `ADD`.
|
||||||
* Tap on `SAVE ACTION`.
|
* Tap on `SAVE ACTION`.
|
||||||
4. Repeat for Double Click (i.e., `/DoubleClick`) and Hold (i.e., `/Hold`) events.
|
4. Repeat for Double Click (i.e., `/DoubleClick`) and Hold (i.e., `/Hold`) events.
|
||||||
@@ -160,7 +160,7 @@ Search the Play Store - there might be others with similar names.
|
|||||||
* `subscription` (object, required): The [PushSubscription object](https://developer.mozilla.org/en-US/docs/Web/API/PushSubscription) obtained from the browser's Push API.
|
* `subscription` (object, required): The [PushSubscription object](https://developer.mozilla.org/en-US/docs/Web/API/PushSubscription) obtained from the browser's Push API.
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"button_id": "game-button", // Optional, defaults to DEFAULT_BUTTON_NAME environment variable
|
"button_id": "game-button",
|
||||||
"subscription": {
|
"subscription": {
|
||||||
"endpoint": "https://your_pwa_push_endpoint...",
|
"endpoint": "https://your_pwa_push_endpoint...",
|
||||||
"expirationTime": null,
|
"expirationTime": null,
|
||||||
@@ -182,19 +182,10 @@ Search the Play Store - there might be others with similar names.
|
|||||||
* **Authentication:** Optional Basic Authentication via `Authorization` header if `BASIC_AUTH_USERNAME` and `BASIC_AUTH_PASSWORD` are configured.
|
* **Authentication:** Optional Basic Authentication via `Authorization` header if `BASIC_AUTH_USERNAME` and `BASIC_AUTH_PASSWORD` are configured.
|
||||||
* **URL Parameters:**
|
* **URL Parameters:**
|
||||||
* `click_type` (required): The type of button press (e.g., `SingleClick`, `DoubleClick`, or `Hold`).
|
* `click_type` (required): The type of button press (e.g., `SingleClick`, `DoubleClick`, or `Hold`).
|
||||||
* **Required Headers:**
|
|
||||||
* `Button-Name`: The identifier of the Flic button (sent by the Flic system). If not provided, the value of `DEFAULT_BUTTON_NAME` environment variable will be used as a fallback.
|
|
||||||
* **Optional Headers:**
|
* **Optional Headers:**
|
||||||
|
* `Button-Name`: The identifier of the Flic button (sent by the Flic system). If not provided, the value of `DEFAULT_BUTTON_NAME` environment variable will be used as a fallback.
|
||||||
* `Timestamp`: Timestamp of the button event (sent by the Flic system).
|
* `Timestamp`: Timestamp of the button event (sent by the Flic system).
|
||||||
* `Button-Battery-Level`: The battery level percentage of the button (sent by the Flic system).
|
* `Button-Battery-Level`: The battery level percentage of the button (sent by the Flic system).
|
||||||
* **Push Notification Payload (`data` field):** The service sends a JSON payload within the push notification. The client-side Service Worker can access this data via `event.data.json()`. The structure is:
|
|
||||||
```bash
|
|
||||||
curl -X GET https://webpush.virtonline.eu/webhook/SingleClick \
|
|
||||||
-H 'Authorization: Basic cGxheWVyOlNldmVuT2ZOaW5l' \
|
|
||||||
-H "Button-Name: Game-button" \
|
|
||||||
-H "Timestamp: 2025-03-26T01:10:20Z" \
|
|
||||||
-H "Button-Battery-Level: 100"
|
|
||||||
```
|
|
||||||
* **Responses:**
|
* **Responses:**
|
||||||
* `200 OK`: Webhook received, push notification sent successfully.
|
* `200 OK`: Webhook received, push notification sent successfully.
|
||||||
* `400 Bad Request`: Missing `Button-Name` header or `click_type` URL parameter.
|
* `400 Bad Request`: Missing `Button-Name` header or `click_type` URL parameter.
|
||||||
|
|||||||
Reference in New Issue
Block a user