POST api/TestAlert?APIKey={APIKey}&ControllerID={ControllerID}&ControllerPassword={ControllerPassword}&ControllerAlertID={ControllerAlertID}

This will send a test Webhook to the registered Alert webhook address for the controller. You must pass the ControllerDataID you would like to send.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
APIKey

The API key provided

 string

Required
ControllerID

The ControllerID of the unit you want to update

 string

Required
ControllerPassword

string

Required
ControllerAlertID

A Controller name for identification on the IPS Controller Website

 string

Required

Body Parameters

None.

Response Information

Resource Description

The system returns a JSON object that contains the results

TestResponse
NameDescriptionTypeAdditional information
Result

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Result": "sample string 1"
}

application/xml, text/xml

Sample: 
<TestAlertController.TestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIreg.Controllers">
  <Result>sample string 1</Result>
</TestAlertController.TestResponse>