Creating an Automated HTTP Request

Creating an Automated HTTP Request

This guide will outline how CHeKT Portal Users can use the "HTTP Request" option in the CHeKT Automation Rule programming menu to activate camera functions such as relays or lights. 
Notes
This function should work for any IP that can take local API Requests, but the user will need to have the correct URL available. The example below is a CHeKT camera. 


Setting up the Rule

In the Dealer Portal configuration menu for automation rules, start by selecting your Source Event. This is the event that will initiate the API Request. We will use Arming Change as our source event for the example. The Site Armed will cause the rule to take place when the state of the system is changed to armed:

For Action, Select HTTP Request:
 

In the expanded menu, you will need to select the type of request, enter the correct URL for the API request and the required login credential:



NotesAlert
This example is from a CHeKT AI Series Bullet. The command  http://xxx.xxx.xxx/cgi-bin/admin/io.cgi?msubmenu=relay&action=apply&idlestate=0 will close the relay on the camera. The method and URL request may be different depending on the brand/model you are working with. Ensure you verify these details with the camera manufacturer or support team.

Choose a conditional filter if applicable. 



Alert
Armed Status is not a filter option as the arming change is already selected as our initial source event
We will use no Operational Condition for our example:

Name your rule and add any additional helpful notes for your other Dealer Portal Users:



And click next:


Testing the Rule

When the source event is activated, that HTTP request should go out to the defined IP address automatically. You can see the record of the request in the site activity logs:




For each instance of your Source Event in the logs, you should see an HTTP Request.

In our example, arming was our source event. You can see the log of the HTTP request and success after the arming:


The log items can be expanded for more granular details. 

In the request line, you can see the API request details:


For your test, you are looking for the success message:


Idea
In the event the request comes back with a failure:
  1. Ensure the bridge has local area network access to the IP range of the target camera
  2. Check the validity for the HTTP URL
  3. Ensure the correct security method has been selected
  4. Verify the presented authentication credentials are valid 


With our CHeKT Camera Example:

  1. When our Arm Request is successful and the state is changed to 0 (Closed) the DO+ and DO - terminals will have continuity. 
  2. When our disarm Request is successful and the state is changed to 1 (open) the DO+ and DO - terminals will not have continuity.



This state-change can be manually toggled in the camera for troubleshooting in the "Trigger Actions" menu:



Info
When the HTTP command from the bridge is working correctly, users will see the state change on this page between opened and closed as the associated Source Event is executed. 





    • Related Articles

    • CHeKT Cameras - Http Endpoint Commands for Camera Functions

      The following is a list of HTTP-based endpoints for CHeKT Cameras that allow you to control various features and functions. These commands can be used in CHeKT Automation Rules, within Stored Procedures in the Monitoring Portal, or from other ...

    • Automation Rule Scenarios: Common and Advanced Use-Case Examples

      With the 5.0 Firmware Version, the array of options to build, filter and suppress CHeKT Automated Rules have been expanded. The purpose of this article is to share some examples of rule combinations that can be used for practical applications in the ...

    • Creating Site Contacts

      Creating Site Contacts The site contacts play an important role in the verifaction of an event via an sms text message. These text verifcations sms are sent by a live operator via the monitoring portal to the customers of a site, these include: the ...

    • Creating Dealer Level Audio Talk Down Messages

      These directions detail how to create predefined audio messages for your sites. Important Notes:  The Audio Talk-Down service for the site must be enabled.  Click here for directions. The Bridge must be installed and wired to a local amplified ...

    • Creating an Mobile App User Account for Sites

      Creating accounts for your customers With the end-user CHeKT app your customer can now monitor and control their home or business in real-time and from anywhere. CHeKT's Visual Security System and automation solution gives your customer instant ...