/OpenForum/AddOn/Alert Sevice API Version 1.0.7

Get Actions

Action getAlerts

Parameters

NameDescription
tag (required=false){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=getAlerts

Example Response

Example Error Response

Action addAlert

Parameters

NameDescription
name (required=true){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=addAlert

Example Response

Example Error Response

Action removeAlert

Parameters

NameDescription
name (required=true){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=removeAlert

Example Response

Example Error Response

Action triggerAlert

Parameters

NameDescription
name (required=true){{parameter.description}}
reason (required=true){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=triggerAlert

Example Response

Example Error Response

Action beatAlert

Parameters

NameDescription
name (required=true){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=beatAlert

Example Response

Example Error Response

Action cancelAlert

Parameters

NameDescription
name (required=true){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=cancelAlert

Example Response

Example Error Response

Action getAlert

Parameters

NameDescription
name (required=true){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=getAlert

Example Response

Example Error Response

Action getTags

Parameters

NameDescription
alertName (required=true){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=getTags

Example Response

Example Error Response

Post Actions