HARQ integrations: webhook, data export and a GeoJSON map
How to get HARQ drone alerts into your own system or a client's: an alert webhook, flight export to CSV and KML, a GeoJSON map feed and VMS or PSIM integration.
Updated:
In short. HARQ passes drone alerts to other systems through a webhook: for every alert we send an HTTPS request with JSON data to the address you give us. Flights can be exported to CSV and KML, and the live map shared as GeoJSON. The webhook comes with the Facility and Critical infrastructure plans; VMS or PSIM integration is set up as part of a Critical infrastructure deployment.
What you can integrate
| Method | What it’s for | Plan |
|---|---|---|
| Alert webhook | a drone alert in your system, team chat or monitoring centre within seconds | Facility, Critical infrastructure |
| CSV and KML export | flights from a chosen day for a report, risk assessment or police report | all |
| GeoJSON map | live drones on a map in another tool, through a link with an expiry date | all |
| VMS / PSIM | alerts next to the camera feed in the system your security team already uses | Critical infrastructure |
Alert webhook
In the console settings, an administrator enters the URL HARQ should send alerts to. For every alert we send an HTTPS POST request with JSON data to that address.
An alert is raised when a new drone appears over your site, when a drone that has been here before comes back, when a drone broadcasts without a GPS position, or when it reports an emergency. Alerts for a new drone, a returning drone and no GPS can each be switched off. Alerts cover only drones that entered the recording zone set for your site.
An example request body with the default settings:
{
"alert": "Wykryto nowego drona",
"alert_type": "new",
"signal_key": "a3f9c2…",
"alias": null,
"isNew": true,
"drone_lat": 50.8118,
"drone_long": 19.1203,
"drone_gmap": "https://www.google.com/maps?q=50.8118,19.1203",
"pilot_lat": null,
"pilot_long": null,
"pilot_gmap": null,
"mac": null,
"basic_id": null,
"faa_data": null
}
What the fields mean:
- alert: a short description of the event for a person to read, in Polish by default (for example “Wykryto nowego drona”) or in English on request (“New drone detected”).
- alert_type: the kind of alert, for the receiving system:
new,reappear,no_gpsoremergency. Base automatic rules on this field rather than on the text. - signal_key: a stable pseudonym for the drone. Two alerts about the same drone share the key, so the recipient can link them without the serial number.
- alias: the drone’s name in the drone database, if you’ve marked it as known, for example your own inspection drone.
- isNew:
truewhen the drone is new and not named in the database, and for no-GPS alerts. - drone_lat, drone_long, drone_gmap: the drone’s position and a map link.
- pilot_lat, pilot_long, pilot_gmap: the pilot’s position.
- mac, basic_id: the transmitter identifiers and the serial number from Remote ID.
The pilot’s position and the identifiers are off by default. A webhook often lands in a team chat or another provider’s system, so we send the most sensitive data only when an administrator switches it on. The fields stay in the JSON as null, so the shape of the data doesn’t change. More on how we process data: privacy policy.
Fields are also null when the drone didn’t broadcast them, for example the position in a no-GPS alert.
Flight export
From the archive in the console you can download a chosen day’s flights:
- CSV: a record of the flights with the data for a police report. It includes identifiers and pilot positions, so every download is recorded in the access log.
- KML: flight tracks to open in Google Earth or a GIS, for one day or all days together.
An event marked as evidence in the archive is kept in full, so the export remains available after the normal retention period.
GeoJSON map
You can share the live drone map as a GeoJSON file behind a link that most mapping tools and GIS systems can load. The link covers one sensor, has an expiry date and leaves out the pilot’s position. Anyone with the link can see the map, so we create it at an administrator’s request.
VMS and PSIM integration
On the Critical infrastructure plan, alerts go to the system your monitoring centre uses: to the VMS next to the camera feed, or to the PSIM alongside other security events. How we connect depends on the system, so we agree it during the deployment, after the site survey.
For integrators
If you install security systems for clients, the webhook lets you add HARQ alerts to what already runs there. We install and service the sensors. Partnership details: Partners and integrators.
We’ll send the full webhook documentation, covering every alert type, on request: kontakt@harq.site.