Notification

Notification settings used by stream monitoring and live search.

Example

{
  "phone_number": "+15551234567",
  "include_image": true,
  "rest_url": "https://example.com/alerts"
}

Request Fields

Field	Type	Description
phone_number	string	Phone number used for SMS notifications.
include_image	boolean	Include a base64 image in the notification when available.
rest_url	string	REST endpoint that receives alert payloads when supported by the deployment.

Response Fields

Field	Type	Description
last_detection	object	Most recent detection details associated with the notification state.
alerting	boolean	Whether the notification target is currently alerting.