github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Notify_Custom_JSON (markdown)

master
Chris Caron 2019-09-07 16:47:41 -04:00
parent 82d8d974df
commit 43dfc17f47
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Notify_Custom_JSON.md

@ -24,16 +24,22 @@ The *type* will be one of the following:
### Syntax ### Syntax
Valid syntaxes are as follows: Valid syntaxes are as follows:
* **json**://**{hostname}** * `json://{hostname}`
* **json**://**{hostname}**:**{port}** * `json://{hostname}:{port}`
* **jsons**://**{hostname}** * `json://{user}:{password}@{hostname}`
* **jsons**://**{hostname}**:**{port}** * `json://{user}:{password}@{hostname}:{port}`
* `json://{hostname}`
* `json://{hostname}:{port}`
* `json://{user}:{password}@{hostname}`
* `json://{user}:{password}@{hostname}:{port}`
### Parameter Breakdown ### Parameter Breakdown
| Variable | Required | Description | Variable | Required | Description
| ----------- | -------- | ----------- | ----------- | -------- | -----------
| hostname | Yes | The Web Server's hostname | 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. | port | No | The port our Web server is listening on. By default the port is **80** for **json://** and **443** for all **jsons://** references.
| user | No | If you're system is set up to use HTTP-AUTH, you can provide _username_ for authentication to it.
| password | No | If you're system is set up to use HTTP-AUTH, you can provide _password_ for authentication to it.
#### Example #### Example
Send a JSON notification to our web server listening on port 80: Send a JSON notification to our web server listening on port 80: