Webhook url - Reolink community request

[macxq]

Hi All!

I have requested implementing webhook on https://community.reolink.com/topic/3291/third-party-integration-support-ai-detection-home-assistant?post_id=13362&_=1664174141358 and Reolink started implementing it and they are asking for:

Q: Does each event type(person/vehicle...) correspond to a URL? Or that multiple event types correspond to one URL, and different event types are distinguished by load information?

Should I recommend the to correlate each event type with different url(webhook id) ?

Any more expectations ? should it be POST and they should add addiction informations in the body ?

[JimStar]

No need to have different webhook URL, if they have all information included in their ONVIF notification about the kind of motion detection.
But I'm surprised they ask about it, because some of their cameras already have that information in their ONVIF SWN notifications they send to a webhook. For example, this is their ONVIF notification that their RLC-810A cameras send to a webhook:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://www.w3.org/2003/05/soap-envelope" xmlns:SOAP-ENC="http://www.w3.org/2003/05/soap-encoding" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsdd="http://schemas.xmlsoap.org/ws/2005/04/discovery" xmlns:xop="http://www.w3.org/2004/08/xop/include" xmlns:chan="http://schemas.microsoft.com/ws/2005/02/duplex" xmlns:wsa5="http://www.w3.org/2005/08/addressing" xmlns:c14n="http://www.w3.org/2001/10/xml-exc-c14n#" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns:saml1="urn:oasis:names:tc:SAML:1.0:assertion" xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:xenc="http://www.w3.org/2001/04/xmlenc#" xmlns:wsc="http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:tt="http://www.onvif.org/ver10/schema" xmlns:wsrfbf="http://docs.oasis-open.org/wsrf/bf-2" xmlns:wstop="http://docs.oasis-open.org/wsn/t-1" xmlns:wsrfr="http://docs.oasis-open.org/wsrf/r-2" xmlns:ns1="http://www.onvif.org/ver20/media/wsdl" xmlns:tdn="http://www.onvif.org/ver10/network/wsdl" xmlns:tds="http://www.onvif.org/ver10/device/wsdl" xmlns:tev="http://www.onvif.org/ver10/events/wsdl" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:timg="http://www.onvif.org/ver20/imaging/wsdl" xmlns:tmd="http://www.onvif.org/ver10/deviceIO/wsdl" xmlns:tptz="http://www.onvif.org/ver20/ptz/wsdl" xmlns:trc="http://www.onvif.org/ver10/recording/wsdl" xmlns:trp="http://www.onvif.org/ver10/replay/wsdl" xmlns:trt="http://www.onvif.org/ver10/media/wsdl" xmlns:trv="http://www.onvif.org/ver10/receiver/wsdl" xmlns:tse="http://www.onvif.org/ver10/search/wsdl" xmlns:ter="http://www.onvif.org/ver10/error" xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tad="http://www.onvif.org/ver20/analytics/wsdl">
    <SOAP-ENV:Header>
        <wsa5:Action SOAP-ENV:mustUnderstand="1">http://docs.oasis-open.org/wsn/bw-2/NotificationConsumer/Notify</wsa5:Action>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <wsnt:Notify>
            <wsnt:NotificationMessage>
                <wsnt:Topic Dialect="http://www.onvif.org/ver10/tev/topicExpression/ConcreteSet">tns1:RuleEngine/CellMotionDetector/Motion</wsnt:Topic>
                <wsnt:Message>
                    <tt:Message UtcTime="2022-09-05T10:32:17Z" PropertyOperation="Changed">
                        <tt:Source>
                            <tt:SimpleItem Name="VideoSourceConfigurationToken" Value="000" />
                        </tt:Source>
                        <tt:Data>
                            <tt:SimpleItem Name="IsMotion" Value="false" />
                        </tt:Data>
                    </tt:Message>
                </wsnt:Message>
            </wsnt:NotificationMessage>
            <wsnt:NotificationMessage>
                <wsnt:Topic Dialect="http://www.onvif.org/ver10/tev/topicExpression/ConcreteSet">tns1:RuleEngine/MyRuleDetector/FaceDetect</wsnt:Topic>
                <wsnt:Message>
                    <tt:Message UtcTime="1970-01-01T00:00:00Z" PropertyOperation="Initialized">
                        <tt:Source>
                            <tt:SimpleItem Name="Source" Value="VideoSourceToken" />
                        </tt:Source>
                        <tt:Data>
                            <tt:SimpleItem Name="State" Value="false" />
                        </tt:Data>
                    </tt:Message>
                </wsnt:Message>
            </wsnt:NotificationMessage>
            <wsnt:NotificationMessage>
                <wsnt:Topic Dialect="http://www.onvif.org/ver10/tev/topicExpression/ConcreteSet">tns1:RuleEngine/MyRuleDetector/PeopleDetect</wsnt:Topic>
                <wsnt:Message>
                    <tt:Message UtcTime="2022-09-05T10:32:21Z" PropertyOperation="Changed">
                        <tt:Source>
                            <tt:SimpleItem Name="Source" Value="VideoSourceToken" />
                        </tt:Source>
                        <tt:Data>
                            <tt:SimpleItem Name="State" Value="false" />
                        </tt:Data>
                    </tt:Message>
                </wsnt:Message>
            </wsnt:NotificationMessage>
            <wsnt:NotificationMessage>
                <wsnt:Topic Dialect="http://www.onvif.org/ver10/tev/topicExpression/ConcreteSet">tns1:RuleEngine/MyRuleDetector/VehicleDetect</wsnt:Topic>
                <wsnt:Message>
                    <tt:Message UtcTime="2022-09-05T10:31:20Z" PropertyOperation="Changed">
                        <tt:Source>
                            <tt:SimpleItem Name="Source" Value="VideoSourceToken" />
                        </tt:Source>
                        <tt:Data>
                            <tt:SimpleItem Name="State" Value="false" />
                        </tt:Data>
                    </tt:Message>
                </wsnt:Message>
            </wsnt:NotificationMessage>
            <wsnt:NotificationMessage>
                <wsnt:Topic Dialect="http://www.onvif.org/ver10/tev/topicExpression/ConcreteSet">tns1:RuleEngine/MyRuleDetector/DogCatDetect</wsnt:Topic>
                <wsnt:Message>
                    <tt:Message UtcTime="2022-09-05T07:34:07Z" PropertyOperation="Initialized">
                        <tt:Source>
                            <tt:SimpleItem Name="Source" Value="VideoSourceToken" />
                        </tt:Source>
                        <tt:Data>
                            <tt:SimpleItem Name="State" Value="false" />
                        </tt:Data>
                    </tt:Message>
                </wsnt:Message>
            </wsnt:NotificationMessage>
            <wsnt:NotificationMessage>
                <wsnt:Topic Dialect="http://www.onvif.org/ver10/tev/topicExpression/ConcreteSet">tns1:VideoSource/MotionAlarm</wsnt:Topic>
                <wsnt:Message>
                    <tt:Message UtcTime="2022-09-05T10:32:17Z" PropertyOperation="Changed">
                        <tt:Source>
                            <tt:SimpleItem Name="Source" Value="000" />
                        </tt:Source>
                        <tt:Data>
                            <tt:SimpleItem Name="State" Value="false" />
                        </tt:Data>
                    </tt:Message>
                </wsnt:Message>
            </wsnt:NotificationMessage>
        </wsnt:Notify>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

You can see there is all the detection-type information in this notification that is needed by the receiving side. So no matter that this notificaion is sent to the same webhook address when different kinds of motions were detected, the receiving webhook, after analyzing all this notification's data, can see if the motion detection is started or finished, and what kinds of objects were detected: Face, People, Vehicle, Dog/Cat, or just "some other motion"...

If you'll get some continuation from Reolink - I can integrate new things they could implement in their firmware, already into the improved version of reolink_dev: reolink_cctv component. reolink_cctv already supports this "rich" kind of Reolink ONVIF notifications, so if it receives such notification, it already uses all notification's detection information directly instead of sending/receiving additional information requests to all the Reolink cameras and analyzing their responses again...

What they still need to implement:

BUT: the additional kind of information they still need to add to their ONVIF notifications - is the channel number for the case if this is sent from an NVR - for the receiving side to know on what exact camera this happened. So that the receiving side not to be forced to re-request all the cameras again to know on what exact camera this happened.

So if you would want some new Reolink features (that they could implement) to be supported too - you can continue this in reolink_cctv discussions here:
https://github.com/JimStar/reolink_cctv/discussions