Integrating with Immix

sending alarms to immix alarms are sent to immix using smtp, using the parameters for the smtp server as described in the immix settings (on the account or on the camera level) the email will contain the video clip with the detection (i e with alarm zones and bounding box for detection drawn into the video) or the frame in which the detection was made (also with alarm zones and bounding box) in case no video was produced the body of the email sent will contain an xml document on the form \<alarm> \<versioninfo>1\</versioninfo> \<input1>1\</input1> \<eventtype>motiondetected\</eventtype> \<extratext>motiondetection true\</extratext> \<datetime>2025 02 26t16 27 54z\</datetime> \<location>\</location> \<url>\</url> \</alarm> the contents is as follows parameter value versioninfo always equal to 1 input1 this is the calculated immix alarm number (see section on server id, alarm number and event type id below) eventtype currently always set to motiondetection in the alarm filter this must be one of the standardized event types in immix, see their documentation extratext currently always set to motiondetection true (for true alarms) or motiondetection false (for false alarms) datetime currently always set to the time the alarm was received by the alarm filter (in utc) by default formatted to yyyy mm ddthh\ mm\ ssz but can be specified by the user through the immix settings url always empty there is also a location tag which can be set in the xml but this can currently not be configured in the alarm filter note that the default value for the date time format is now in iso 8601, but always using utc the immix recipient tested with so far ( immix testmydevice https //testmydevice immixprotect com/ ) is able to convert the utc timestamps to server local time setting for immix integration the following settings are configurable through the backend hostname hostname of immix smtp server port immix smtp server port number default is 25 username the username of the smtp server credentials (omit to disable credentials) password the password of the smtp server credentials (omit to disable credentials) requirestarttls set to true to require the use of tls encryption (using starttls command) acceptsystemalarms \[ignored at the moment] fromemailaddress the from address of the email sent emaildomain the domain part of the email to send (e g immix com) alarmnumber (nullable integer) this is the alarm number, can be any integer , serverid the server id of the site (as configured in immix) which is also the username part of the email to send (e g s211 a1) includeboundingboxes if true, the bounding box (if available) will be drawn onto the video clip emailsubject subject to include in the email default subject uses the immix standard alarm type of the actual alarm, e g motiondetected datetimeformat format of the timestamp sent to immix if not set then the format yyyy mm ddthh\ mm\ ssz is used server id, alarm number and event type id the immix integration require at least a server id and an alarm number the alarm filter will use these settings from, in order of priority outgoing id of the camera if the outgoing id is set an is on the format ‘sxx axx’ then the serverid and alarm number will be taken from here examples s4445 a4 => serverid = s4445, alarm number=4 s4445a7 => serverid = s4445, alarm number=7 s212=> serverid = s212, alarm number will be taken from the alarm notifier settings incoming id of the camera if the outgoing id is not set on the camera, then the incoming id will be parsed and if this is on the format ‘sxx axx’, ‘sxx axx’ or ‘sxxaxx’ then the serverid and alarm number will be taken from here examples s213 a5\@af irisity io => serverid = s213 and alarm number = 5 s213\@af irisity io => serverid = 213, alarm number will be taken from the alarm notifier settings the immix alarm notifier used if the outgoing id is not set or does not follow the expected format, and the incoming id does not follow the expected format then both will be taken from the settings more details can be found in the documentation https //docs irisity com/alarm filtering beta/api documentation#4a6m6 https //docs irisity com/alarm filtering beta/api documentation#4a6m6 notice the event type id is never used in the alarm filter destination email the emails will always be sent to ‘serverid\@domain com’, whereas the alarm number will be included in the xml body of the email (the input1 tag) retry policy the alarm filter uses a retry policy for sending alarms to immix as follows if the server responds with a 5xx status code then no retry is used if there is a timeout or other status code responded from the server then the system will try again to send the alarm up to five attempts is being done, with five seconds sleep time between each attempt receiving immix alarms the alarm filter is also able to receive emails with an immix xml request body (assuming that the email does in fact also contain an attached video or image) the alarm filter will parse the timestamp of the received immix request and set this as the receivedat timestamp the extratext and url are also read and saved but are currently not used anywhere