Sign in

v1

latestOpenAPI 3.0.02026-08-042710098.2 KB
alerts

Create firearm alert

Creates a firearm-detection alert configuration. Recipients are specified by email (matched case-insensitively) and resolved to platform users in your organization; each recipient's notify_by_sms/notify_by_push only deliver when the user has a phone number / registered device. The schedule is interpreted in each camera's local time. The alert is attributed to the API key (creator_name = the key's identity). Note: a null name is omitted from the response rather than serialized as null.

post/v1/alerts/firearm

Request body

namestring
camera_mac_addressesstring[] required
sensitivity'Low' | 'Medium' | 'High'

An enumeration.

handgun_positive_stancesHandgunStanceType[]
push_notification_level'active' | 'critical' | 'passive' | 'time-sensitive'

Defines the interruption level for mobile push notifications.

This level determines the notification priority and how it will interrupt the user:

  • ACTIVE: Standard priority notifications
  • CRITICAL: High priority notifications that can break through focus modes and DND.
  • PASSIVE: Low priority notifications that don't trigger sounds or banners
  • TIME_SENSITIVE: Important time-sensitive notifications that can break through some focus modes

Response

Successful Response

firearm_alert_idinteger required
namestring
camera_mac_addressesstring[] required
sensitivity'Low' | 'Medium' | 'High' required

An enumeration.

handgun_positive_stancesHandgunStanceType[] required
push_notification_level'active' | 'critical' | 'passive' | 'time-sensitive' required

Defines the interruption level for mobile push notifications.

This level determines the notification priority and how it will interrupt the user:

  • ACTIVE: Standard priority notifications
  • CRITICAL: High priority notifications that can break through focus modes and DND.
  • PASSIVE: Low priority notifications that don't trigger sounds or banners
  • TIME_SENSITIVE: Important time-sensitive notifications that can break through some focus modes
created_atstring date-time required