Skip to content

Commit 6ae06e9

Browse files
committed
Merge branch 'main' of https://github.com/djdd87/SynoAI
2 parents 28a7343 + 1987734 commit 6ae06e9

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

+29-1
Original file line numberDiff line numberDiff line change
@@ -182,12 +182,16 @@ The [Pushbullet](https://www.pushbullet.com/) notification will send an image an
182182
* ApiKey [required]: The API key for the Pushbullet service
183183

184184
### Webhook
185-
The webhook notification will POST an image to the specified URL with a specified field name.
185+
The webhook notification can be used to make web requests (e.g. API calls) either with or without the image that triggered the alert.
186186

187+
#### Configuration
187188
```json
188189
{
189190
"Url": "http://servername/resource",
190191
"Method": "POST",
192+
"Authentication": "Bearer",
193+
"Token": "XYZ.123456",
194+
"SendImage": "false"
191195
}
192196
```
193197
* Url [required]: The URL to send the image to
@@ -206,6 +210,30 @@ The webhook notification will POST an image to the specified URL with a specifie
206210
* ImageField [optional] (Default: ```image```): The field name of the image in the POST data
207211
* SendImage [optional] (Default: ```true```): The image will be sent to the webhook when the method is POST, PATCH or PUT.
208212

213+
#### Example POST data
214+
The following is example data for when ```SendImage``` is ```false```.
215+
216+
```json
217+
{
218+
"camera": "Driveway",
219+
"foundTypes": [
220+
"Car"
221+
],
222+
"predictions": [
223+
{
224+
"Label": "car",
225+
"Confidence": 67.89117,
226+
"MinX": 1738,
227+
"MinY": 420,
228+
"MaxX": 2304,
229+
"MaxY": 844,
230+
"SizeX": 566,
231+
"SizeY": 424
232+
}
233+
],
234+
"message": "Motion detected on Driveway\n\nDetected 1 objects:\nCar"
235+
}
236+
```
209237
### Telegram
210238
The telegram bot will send notifications and images when motion has been detected. To use this notification, you will need to set up your own Telegram bot using [one](https://core.telegram.org/bots#6-botfather) of the many [guides](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-channel-connect-telegram?view=azure-bot-service-4.0) available.
211239

0 commit comments

Comments
 (0)