The HTTP action can interact with public HTTP-based APIs like ticketing systems, collaboration suites and hardware devices in a number of ways:
•Submit a form
•POST data
•PUT data
•GET request
The HTTP action supports both HTTP and HTTPS, authentication (Basic, Digest and NTLM) and allows for up to 20 form elements to be submitted. Form elements can either contain static information, or dynamic information through the use of variables.
Note that the HTTP action can not only be triggered by events (like all other actions), but also by the System Tray Utility to facilitate the creation of support tickets in web-based ticketing system.
The HTTP action can either be configured to submit data to a HTTP-based form (or pages which expect form-type data) by selecting Form Submission as type, or submit custom data via a POST or PUT request by selecting POST/PUT Data. Consult the API documentation to determine which type will work correctly.
Load template
When submitting event data to a web service listed under templates, simply select the template and all required form fields will automatically be pre-loaded. User-specific fields (e.g. API keys) will need to be manually configured and are indicated with text enclosed in <>.
|
To suggest a new web service to be included in the list of templates, simply send us an email. |
URL
The URL of the web page that contains the form to submit. This field supports variables.
Authentication
Authentication Method: Basic Authentication, Digest and NTLM are supported authentication methods.
Username / Password: The authentication credentials.
|
It is recommended to only use basic authentication when submitting a form through a secure (https://.......) web page. |
Proxy Server
If the specified web page has to be accessed via a proxy server, then a proxy server can be associated with the HTTP action. Clicking on the Settings button in the "Proxy" area will display a dialog where proxy settings can be configured. Enabling the "Use Proxy" check box will activate the proxy server settings.
Form Submission: Form Fields
Up to 20 form fields can be specified to be submitted. You can either include dynamic information by using one of the supported variables, or specify static information for the form fields.
The "Form Element Name" is the name of the form element, whereas "Value" refers to the contents of the form element value. Please see the Variables chapter for information as to which variables are supported.
POST/PUT Data
For APIs which expect POST or PUT requests, the content type, submission type (POST/PUT) and data need to be defined. The same variables which are supported in the Form Fields are supported in the data field as well.
Convert to UTF8: Converts dynamic data from variables (e.g. $EVENTSOURCE, $EVENTMESSAGE ...) to UTF8 before transmitting.
A typical POST/PUT setup is shown in the screenshot below:
GET
Submits a HTTP GET request to the specified URL. Data returned by the web page is available in event 642 logged if the HTTP(S) GET request was successful.
