Shinobi
Documentation
Home  /  API  /  Monitor Triggers

Monitor Triggers

[ACTION] is the action in which you want to run. See below for a list of available actions.

http://xxx.xxx.xxx.xxx/[API KEY]/control/[GROUP KEY]/[MONITOR ID]/[ACTION]
  • center
  • up
  • down
  • left
  • right
  • enable_nv
  • disable_nv
  • zoom_in
  • zoom_out

This is a way to trigger the Motion Engine through a GET request.

http://xxx.xxx.xxx.xxx/[API KEY]/motion/[GROUP KEY]/[MONITOR ID]?data={"plug":"camera1","name":"stairs","reason":"motion","confidence":197.4755859375}
  • plug : The name of the plugin. You can put the name of the camera.
  • name : The name of the region. Example : door
  • reason : The reason for this trigger. Example : motion
  • confidence : A number to signify how much confidence this engine has that there is motion. Example : 197.4755859375

Use this to help you test webhook usability of an external script.

http://xxx.xxx.xxx.xxx/[API KEY]/hookTester/[GROUP KEY]/[MONITOR ID]
http://xxx.xxx.xxx.xxx/[API KEY]/monitor/[GROUP KEY]/[MONITOR ID]/[MODE]
  • stop, start, record
  • stop = Disabled
  • start = Watch-Only
  • record = Record
http://xxx.xxx.xxx.xxx/[API KEY]/monitor/[GROUP KEY]/[MONITOR ID]/[MODE]/[TIME]
http://xxx.xxx.xxx.xxx/[API KEY]/monitor/[GROUP KEY]/[MONITOR ID]/[MODE]/[TIME]/[TIME INTERVAL]
http://xxx.xxx.xxx.xxx/XXXXXXXXXXXXXXXXX/monitor/2Df5hBE/bunny/record
http://xxx.xxx.xxx.xxx/XXXXXXXXXXXXXXXXX/monitor/2Df5hBE/bunny/record/10/min
min, minute, minutes, hr, hour, hours, day, or days

ShinobiDocs

All content is property of their respective owners.