Notification

Encapsulates input settings to define alert notifications through SMS, REST APIs or VMS Integration.

Example

{
	"name": "Street Camera",
	"stream_url": "rtsp://username:password@192.168.1.13/live0",
	"frame_rate": 5,
	"regions": [...],
	"lines": [...],
	"notification": {
		"phone_number": "+11234567890",
		"image_notification": true,
		"genetec": {
			"webhook_event_id": 101,
			"webhook_camera_uuid": "7653b9a1-8d9e-4c3d-9dc6-bd05fe017a71"
		},
		"rest_url": "http://192.168.86.176/alerts/handleAlert?port=5001"
	}
}

Attributes

Name	Type	Description
phone_number	string	a phone number for SMS alert. Must begin with a country code and contain only + and numbers. If not used, this should be null.
image_notification	boolean	true to include an image with the alert, false otherwise.
genetec	Genetec Stream Config	configuration information for sending alerts through Genetec for all detection configurations for this stream.
rest_url	string	a URL for sending a REST notification

When the rest_url is provided, EyesOnIt will send JSON data following the detection structure to the rest_url when a notification is triggered. The image attribute is only sent if image_notification is true. The JSON below is an example of the JSON sent:

{
	"detections": [
		{
			"stream_url": "rtsp://192.168.1.14/live0",
			"region": "Office",
			"time": "2025-02-25 16:00:44",
			"class_name": "person",
			"condition": {
				"type": "count_greater_than",
				"count": 0,
				"line_name": null,
				"alert_direction": null,
				"objects": [
					{
						"object_description": "person standing",
						"confidence": 93,
						"bounds": {
							"left": 939,
							"top": 305,
							"width": 341,
							"height": 412
						}
					}
				]
			}
		}
	],
	"image": "<base-64 encoded image>"
}