diff --git a/Notify_Custom_XML.md b/Notify_Custom_XML.md new file mode 100644 index 0000000..75546e7 --- /dev/null +++ b/Notify_Custom_XML.md @@ -0,0 +1,50 @@ +## XML HTTP POST Notifications +* **Source**: n/a +* **Icon Support**: No +* **Message Format**: XML +* **Message Limit**: 32768 Characters per message + +This is just a custom Notification that allows you to have this tool post to a web server as a simple XML string. This is useful for those who want to be notified via their own custom methods. + +The format might look something like this: +```xml + + + + + 1.0 + What A Great Movie Downloaded Successfully + info + Plenty of details here... + + + +``` +The *MessageType* will be one of the following: +* **info**: An informative type message +* **success**: A successful report +* **failure**: A failure report +* **warning**: A warning report + +### Syntax +Valid syntaxes are as follows: +* **xml**:://**{hostname}** +* **xml**:://**{hostname}**:**{port}** +* **xmls**:://**{hostname}** +* **xmls**:://**{hostname}**:**{port}** + +### Parameter Breakdown +| Variable | Required | Description +| ----------- | -------- | ----------- +| hostname | Yes | The Web Server's hostname +| port | No | The port our Web server is listening on. By default the port is **80** for **xml://** and **443** for all **xmls://** references. + +#### Example +Send a XML notification to our web server listening on port 80: +```bash +# Assuming our {hostname} is xml.server.local +notify xml://xml.server.local +``` \ No newline at end of file