mirror of
https://github.com/caronc/apprise.git
synced 2024-12-12 18:01:08 +01:00
Created Notify_Custom_XML (markdown)
parent
c96365d936
commit
ee2c45ba6a
50
Notify_Custom_XML.md
Normal file
50
Notify_Custom_XML.md
Normal file
@ -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
|
||||
<?xml version='1.0' encoding='utf-8'?>
|
||||
<soapenv:Envelope
|
||||
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
||||
<soapenv:Body>
|
||||
<Notification xmlns:xsi="http://nzbget.lead2gold.org/notify/NotifyXML-1.0.xsd">
|
||||
<Version>1.0</Version>
|
||||
<Subject>What A Great Movie Downloaded Successfully</Subject>
|
||||
<MessageType>info</MessageType>
|
||||
<Message>Plenty of details here...</Message>
|
||||
</Notification>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
```
|
||||
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
|
||||
```
|
Loading…
Reference in New Issue
Block a user