Key Concepts:
•When the event rule is true and valid, a preformed HTTP(S) request is sent to a specified URL.
•The request must be formed with a syntax that is acceptable and actionable by the receiving device.
•Bidirectional communications with external devices or services can be maintained when combined with a Generic Event.
•Multiple receiver-authentication methods and content types are supported.
•The following methods can be sent:
oAuto
oGET
oPOST
oPUT
oPATCH
oDELETE
Begin When:
The Begin When setting appears only for supported events and the following options will varying by event type:
•When event occurs is the moment an instantaneous events occurs.
•When event starts is the moment the event rule became true and valid.
•When event stops is the moment the event rule was no longer true and valid.
URL:
Enter the complete URL where the request (content) will be sent.
Method:
Select the HTTP(S) method to be sent.
Content:
Enter the complete body of the request to be delivered to the URL, including any Event Field Metadata.
Content Type:
Select the content type required by the receiving service:
•Auto
•text/plain
•text/html
•application/html
•application/jsonE
•application/xml
NOTE: Auto selects the best format based on the content entered.
Authentication Type:
Select the authentication type required by the receiving service and provide the credentials to use:
•Auto, Basic, and Digest required a Login and Password be provided.
•Bearer requires a token to be provided
Interval of Action:
To avoid overlapping actions, enable the interval of action and set the Once in duration to be longer than the execution time of the action.
•Move the slider switch to enable or disable the interval of action control.
•If enabled, a numerical value for the interval of action and a unit of measurements is required.
Example Content Syntax:
The following example and descriptors are for illustrative purposes only:
http://123.12.8.1:7001/api.clickandcall.com/http/sendmsg?login=VMSuser&password=123456&api_id=3612726$MO=1&from-13234567890&to=18184493546$text=suspicious+motion+at+loading+bay
•sendmsg – Sends data to a server at IP Address 123.12.8.1 port 7001
•login and password – credentials required by the receiver to allow the request access to their platform.
•api_id – required account number with receiving entity.
•from – phone number from which the message will be sent.
•to – phone number to which the message is sent.
•text – the message text, in this case "Visitor is outside front door".
Action Troubleshooting:
•Event is not configured properly to initiate the DO HTTP(S) Request action.
•The request syntax is incorrect or not understood by the receiver.
•External authorization issue from incorrect or missing credentials.
Dialog Controls:
•Click Apply to update the event rule and keep the dialog open.
•Click OK to save settings and close the dialog.
•Click Cancel or use the close window control to discard any changes not applied and close the dialog.