Skip to content

Notification configuration notes

dgtlmoon edited this page Oct 9, 2024 · 25 revisions
  • Be sure that your notification body contains atleast something, often {base_url} will be empty, an empty notification body often causes problems with many notification targets
  • Make sure you're not exceeding your target notification service message length when using {current_snapshot}, {diff} or {diff_full} tokens

ARMv7 (RaspberryPi 3 etc)

Discord and Telegram notifications are not super reliable on these devices, this is an issue for apprise not for changedetection.io

Looks like there's an issue with some ARMv7 devices https://github.com/dgtlmoon/changedetection.io/issues/217#issuecomment-1013917577 https://github.com/dgtlmoon/changedetection.io/discussions/366 - this is not fixable by my and has something todo either with the cross platform docker system or apprise

Also https://github.com/dgtlmoon/changedetection.io/issues/407 (rPi "permission denied")

Discord

Email

Example

Your SMTP server is located at mail.mycompany.com and your target email address is steve@gmail.com

You would specify it as mailto://<from-including-smtp-server>?to=email

mailto://john@mail.mycompany.com/?to=steve@gmail.com

For more help - see the Apprise email info https://github.com/caronc/apprise/wiki/Notify_email

POST/POSTS

version (0.45.8.2+)

You can create arbitrary HTTP POST notifications using post:// or posts:// (SSL). To include a header - like for example if you need an authentication header, it needs to be added to the URL as &+custom-header=hello

For example

posts://service.com?yes=please&+custom-header=hello

custom-header will be stripped from the URL and only used as a header, but you need to prefix it with + to declare it as a header.

Forms/HTTP POST support

This is for doing an actual HTTP webform style subsmission.

JSON style POST / PUT requests

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

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

GET/PLAIN API

Avoid using json:// (use get://, post://, posts:// for SSL etc), however if you need to add some special GET arguments (?var=123&var2=4444) you need to follow these steps

See https://github.com/caronc/apprise/wiki/Notify_Custom_JSON#get-parameter-manipulation for the special syntax