Skip to main content
Version: latest

U-Filter HTTP API

Sends an HTTP POST message to a given endpoint (configured in the HTTP webhook interface) with metadata of the filtered incident. Content type: application/json.

Message schema

The content type of messages is application/json. The content is described in proto in this document.

{
"api_version": 1, // U-Filter API version for compatibility checking
"event_type": "INTRUSION", // will be extended in the future
"event_id": "5490f2c8-fa8d-4e80-a766-27bb8836bd80", // UUID, different for each notification
"account_name": "Elite Team Security",
"site_display_name": "My Site 1",
"site_technical_name": "my_site_1",
"camera_display_name": "Camera 1 ",
"camera_technical_name": "camera_1",
"camera_external_id": "Securithor_ID", // camera id on an external system
"geolocation": {
"lat": 2.3,
"lng": 0.0
}, // gps coordinates of the camera can be undefined
"message": "An intrusion is detected", // Text message for the operator, can be undefined
"detections": [{
"type": "CAR", // object type, can be PERSON, CAR, BUS, TRUCK, MOTORCYCLE, BICYCLE, TRAIN, BOAT, AIRPLANE
"position": {
"x": 231, //top-left point in the original resolution
"y": 135, //top-left point in the original resolution
"w": 20, //width in pixels
"h": 50 //height in pixels
}
}],
"timestamp": 1671024231000, // epoch time in milliseconds
"img_url": "data:image/jpeg;base64,/9j/4AAQS...", // can be null
"resolution": {
"w": 1920, //image width in pixels
"h": 1080 //image height in pixels
}
}

Event type handling

Consult the table below to see what event types correspond to their U-Filter counterparts, as well as whether the given event type is able to send an image attachment.

Event type in U-FilterEvent type in HTTP messageImage attachment
NEGATIVE_EVENTINTRUSION_NEGATIVEYes (if selected)
FIRST_OVERLOAD_COOLDOWNINTRUSION_OVERLOADNO image
ERRORERRORNO image
INVALID_IMAGEINVALID_IMAGENO image