- News & Events
Notification Engine: 2.6.1612
This version of the Notification API and Notification Engine 2.6 delivers on SST’s commitment to making ShotSpotter easily accessible to external systems such as video surveillance (CCTV) systems. The release supports new functionality for Reviewed Alerts customers, a suite of new and more robust message packets, support for recent Microsoft Windows server environments, and a number of support and compatibility upgrades.
New upgrades to the ShotSpotter Notification API and Notification Engine 2.6 are substantial:
Support for Incident Review Workflow (Unreviewed/Raw Incidents and Reviewed Alerts)
For customers of SST’s ShotSpotter FlexSM subscription based service, raw incident data are reported directly to the SST Incident Review CenterTM (IRC) where our Reviewed Alerts ServiceSM provides immediate assessment and qualification of gunshot alerts by a highly trained team of SST gunfire and acoustics experts, 24x7x365. For customers of SST’s ShotSpotter OnSite (capital equipment) products, the Reviewed Alert Service is available as an option, or customers can choose to review all the raw incidents themselves. Over time, most SST customers have chosen to avoid the expense and effort of training their own 24x7x365 staff and now rely on SST’s Reviewed Alerts Service. SST incident reviewers have quite literally heard more gunfire incidents, from a wider variety of distances and acoustic environments, than anyone else in the world. After review and subsequent customer alert, many customers seek to have ShotSpotter data automatically transmitted (notified) to external systems which had not been previously notified of the raw (unreviewed) alert.
Thus there are two types of notifications:
There are several other differences between the two classes of notifications:
Machine + Reviewer
Other Situational Context
Provided when available
< 1 second after location
SLA 90% within 60 seconds of receipt of data; average < 20 seconds
Notification Appropriate for
Relatively low cost to respond, fast response (< 10 seconds) actions:
· PTZ Cameras
· DVR timestamp/tagging
· UAV look-at-target (camera slew)
· Other Sensor triggering
Relatively high cost to respond, slower response (> 10 seconds) actions:
· Officer or first responder dispatch
· CAD record creation
· Air (helicopter) asset mission
· UAV fly-to-target
Typical Daily Volumes
Peak Volumes (holidays)
Updates Sent by ShotSpotter
Supported in Notification Engine version
The ShotSpotter Notification APITM can report new incidents or updated information about incidents previously reported. As its name suggests, the design of the Notification API focuses heavily on notification of new (or recently updated) incidents and not on making historical data available for analysis. Reviewed and unreviewed (raw) alerts follow slightly different notification workflows, as depicted in the following diagram.
Incident-by-incident notification is performed by the ShotSpotter Notification Engine. The Notification Engine runs on most modern Microsoft Windows operating systems and:
Version 2.6 delivers substantial upgrades over previous versions:
Incident Workflow Status
Unreviewed Alerts, Reviewed Alerts, Reviewed Updates to Unreviewed Alerts
Single Gunfire, Multiple Gunfire, Possible Gunfire, Firecracker/Fireworks, Backfires, Others
9 Generation I Packets
5 Generation II (Advanced) Packets
Geospatial Boundary Awareness
Two-levels of customizable geographic boundaries reported for each incident
Street Address Lookup (Reverse Geocoding)
Parcel map, address point, or Bing maps web service
Operating System Support
32-bit Windows XP, Windows 7, Windows Server 2003, 2008
64-bit Windows 7, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012 (beta)
ShotSpotter Product Support
HTTP POST (XML payload)
HTTP GET (query string)
Google Earth .KML
HTTP query string (key=value)
Generation II Message Packets
With Version 2.6 of the ShotSpotter Notification API and Notification Engine, SST has introduced a new family of message packets designed for both the ShotSpotter OnSite (capital equipment) and ShotSpotter Flex (subscription) products and business models. We refer to this new family of message packets as Generation II message packets. Message packets supported by earlier API versions are referred to as Generation I message packets.
Extended Alert with Multimedia (audio) URLs
scheduled for future release
The Generation II packet formats provide incident notification (alert) via the IALRT0x group of packets, three of which are introduced with API Version 2.6. To accommodate Incident Review Center (or customer-premises) incident review workflow, a new IUPDT0x group of packets is introduced to permit subsequent update to incident information after initial (raw) alert. Developers have often asked for API-level access to ShotSpotter sensor audio (e.g. an .mp3 recording of the gunfire incident as heard at each sensor, plus one to two seconds of audio before and after). The new Generation II packet IALRT03 and IUPDT03 provide audio URLs to all available sensor audio and are structured to provide support in the future for other multimedia types, including for example aerial imagery of the incident location showing a “dot on the map.” The packet types available are:
Message Packet Prefix
“Basic” alert with minimal information to pan-tilt-zoom devices, can accept a geo-referenced endpoint and will calculate relative range/bearing/elevation.
“Detailed” alert packet with detailed information regarding the incident, can accept a geo-referenced endpoint and will calculate relative range/bearing/elevation.
Extended Alert with Multimedia (audio) URLs
Extended “detailed” alert packet with detailed information regarding the incident and provides a variable number of associated URLs for incident audio, etc.
Update packet supporting Reviewed Alerts and other after-detection updates (classification change, etc.). Issued to subscribers of IALRT02 messages.
Update packet supporting Reviewed Alerts and other after-detection updates (classification change, etc.). Issued to subscribers of IALRT03 messages.
Documentation for the ShotSpotter Notification API and Notification Engine 2.6 have been fully updated and revised. Developers, data scientists, and third-party software integrators should request copies of the following documents from their SST points of contact or from SST Customer Support:
Due to patent licensing restrictions, the software cannot be made available for free download. However, Version 2.6 of the Notification Engine software is available as a no-cost upgrade to all customers and integrators with current Integration API licenses. Furthermore, integrators, software developers, and technology partners can receive special development copies of the software free of charge by contacting ShotSpotter Product Management or Sales Operations:
James G. Beldock
SVP Products & Marketing
+1 (510) 794-3117
Manager, Sales Operations
+1 (510) 794-3110
SST Customer Support is available to all customers with valid ShotSpotter Flex Support contracts. You may contact SST Customer Support:
Via Live Chat:
From either the ShotSpotter Flex Alert Console or the ShotSpotter Flex Incident & Reports Portal, look for the chat links:
or by following this link in any web browser:
Phone support is available Monday-Friday, 8:00 am to 5:00 pm Pacific Standard Time. Please contact our support team during these hours at: +1 (888) 274–6877, then dial option 4.
Email firstname.lastname@example.org. Please include as much detail as possible so we may better serve you quickly.