Alerting

The JSON Alerting element encapsulates alert settings that are provided as input to EyesOnIt as well as alert status values that are provided as output by EyesOnIt.

Example

"alerting": {
	"alert_seconds_count": 2,
	"reset_seconds_count": 10.0,
	"phone_number": "+11234567890",
	"image_notification": true,
	"genetec": {
		"webhook_event_id": 5023,
		"webhook_camera_uuid": "00000001-0000-babe-0000-b8a12f745676"
	},
	"rest_url": "https://192.168.1.25:5000/alerts/handle_alert"
	"last_detection": {
		"prompt_values": {
			"vehicle": 91,
			"driveway": 97
		},
		"alerting_prompt": "vehicle",
		"alert_time": "2024-07-13 21:22:31"
	},
	"alerting": true
}

Input Attributes

Name	Type	Description
alert_seconds_count	decimal	the number of seconds that the confidence level for an object description needs to stay above the alert threshold for that object description before an alert will trigger. This value should be between 0.1 and 3600
reset_seconds_count	decimal	the number of seconds that the confidence level for an object description needs to stay below the alert threshold for the alert condition to reset. This value should be between 0.1 and 3600.
phone_number	string	the phone number for SMS alerts. This string needs to be of the form "+11234567890" where the country code precedes the phone number digits without any other characters. Charges apply for SMS alerts.
image_notification	boolean	true to include an image with SMS notifications, false to exclude the image. Additional charges apply for SMS alerts with images.
genetec	Genetec	Settings for sending alerts through Genetec
rest_url	string	the REST URL to post alert data to when a detection occurs

Ouput Attributes

These attributes are provided by EyesOnIt as output in response to certain status request endpoints.

Name	Type	Description
last_detection	LastDetection	Details about the most recent detection
alerting	boolean	true if the stream is in the alerting state, false otherwise