Read only Webhook ID property

Amended some documentation.
This commit is contained in:
Philip Abbey
2024-01-12 17:34:05 +00:00
parent 827d0dbeec
commit 9df93c0c23
7 changed files with 15 additions and 16 deletions

View File

@ -243,10 +243,10 @@ There's an online way of testing the API URL too, thanks to [REQBIN](https://req
URL for copy & paste:
```
https://<Your Domain>/api/events/garmin.battery_level
https://<Your Domain>/api/webhook/<Your Webhook ID>
```
![API Test REQBIN](images/api_test_online_battery1.png)
![API Test REQBIN](images/api_test_online_battery.png)
JSON for copy & paste:
@ -255,7 +255,7 @@ JSON for copy & paste:
"type": "update_sensor_states",
"data": [
{
"state": 19,
"state": 40,
"type": "sensor",
"unique_id": "battery_level"
},
@ -267,5 +267,3 @@ JSON for copy & paste:
]
}
```
![API Test REQBIN](images/api_test_online_battery2.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 68 KiB

View File

@ -15,15 +15,6 @@
<properties>
<property id="api_key" type="string"></property>
<!--
The webhook ID is the last part of the webhook URL.
It is secret and should not be shared.
It will not be set in settings but will be
generated by the application and stored in
persistent storage.
-->
<property id="webhook_id" type="string"></property>
<!--
Internal URL "https://homeassistant.local/api"
External URL "https://<dynamic DNS>/api"
@ -89,4 +80,13 @@
-->
<property id="battery_level_refresh_rate" type="number">15</property>
<!--
The webhook ID is the last part of the webhook URL.
It is secret and should not be shared.
It will not be set in settings but will be
generated by the application and stored in
properties, but read only for trouble shooting.
-->
<property id="webhook_id" type="string"></property>
</properties>

View File

@ -109,8 +109,8 @@
<setting
propertyKey="@Properties.webhook_id"
title="Webhook ID"
title="@Strings.WebhookId"
>
<settingConfig type="alphaNumeric" />
<settingConfig type="alphaNumeric" readonly="true" />
</setting>
</settings>

View File

@ -59,4 +59,5 @@
<string id="SettingsWidgetStart">(Widget only) Automatically start the application from the widget without waiting for a tap.</string>
<string id="SettingsEnableBatteryLevel">Enable the background service to send the clock battery level to Home Assistant.</string>
<string id="SettingsBatteryLevelRefreshRate">The refresh rate (in minutes) at which the background service should repeat sending the battery level.</string>
<string id="WebhookId">(Read only) The Webhook ID created by the watch for battery level updates. You might require this for debugging.</string>
</strings>