diff --git a/Notification-configuration-notes.md b/Notification-configuration-notes.md index 5ca979f..b66ced2 100644 --- a/Notification-configuration-notes.md +++ b/Notification-configuration-notes.md @@ -46,11 +46,25 @@ This is for doing an actual HTTP webform style subsmission. - see https://github.com/caronc/apprise/wiki/Notify_Custom_Form -## JSON +## JSON style POST / PUT requests -Use the `jsons://` notification type and simply set the body in the "Notification body" +If you have a JSON style notification you want to send, do **not** use `json://` _(it does not do what you think it does)_, use `post://`, `posts://`, `put://` or `puts://` etc -See note about headers in the POST/POSTS section +When the notification fires the application will attempt to check if there is a valid JSON document, if there is, it will automatically append the `Content-type: application/json; charset=utf-8` HTTP header + +Always use **`|tojson`** to be sure the string is safe in JSON, for example + +**Notification body example** + +``` +{ + 'myKey': 1234, + 'url': '{{watch_url|tojson}}' +} + +``` + +For extra headers - see note about headers in the [POST/POSTS section](#postposts) ## GET/PLAIN API