Created Notify_Custom_JSON (markdown)

lead2gold 2017-11-29 20:32:53 -05:00
parent d1d1364079
commit c96365d936

43
Notify_Custom_JSON.md Normal file

@ -0,0 +1,43 @@
## JSON HTTP POST Notifications
* **Source**: n/a
* **Icon Support**: No
* **Message Format**: JSON
* **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 JSON string. This is useful for those who want to be notified via their own custom methods.
The format might look something like this:
```json
{
"version": "1.0",
"title": "What A Great Movie Downloaded Successfully",
"message": "Plenty of details here",
"type": "info"
}
```
The *type* 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:
* **json**:://**{hostname}**
* **json**:://**{hostname}**:**{port}**
* **jsons**:://**{hostname}**
* **jsons**:://**{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 **json://** and **443** for all **jsons://** references.
#### Example
Send a JSON notification to our web server listening on port 80:
```bash
# Assuming our {hostname} is json.server.local
notify json://json.server.local
```