Webhooks

To set up data transfer via webhooks, go to the config/run_params.json configuration file and specify values for the webhook_tracking_subscribers parameter. This parameter represents a list of objects to determine the address of the server that receives data from OMNI agent and is available in two versions:

Version 1

{
    "url": "http://127.0.0.1:5000/trigger" // address with the endpoint
}

Version 2 (default)

{ 
    "host": "127.0.0.1", // address
    "port": "5000", // port
    "is_secured": false, // http/https flag
    "path": "/trigger" // endpoint
}

You can also add a webhook in Settings of OMNI Agent web interface.

Data is transmitted via webhooks in the format of processes. An array of processes is sent every 5 seconds (by default) as well as at the beginning and end of tracking, when a person is matched with a database, when a person gets into ROI or crosses marked lines.

To change the process transfer interval, edit the ongoings_interval_in_msec field in the config/run_params.json file (measured in milliseconds).

To send bestshots via webhooks, enable the "Send bestshots in webhook" option in the Settings of the OMNI Agent web interface, or specify the value true for the enable_webhook_image2jpg_conversion field. The default value is false. The bestshot is encoded in base64 as a jpeg image.