Skip to content

Commit

Permalink
3rd party backend docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dschep committed Mar 30, 2018
1 parent 2783160 commit 9b5e7d2
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,8 @@ name and then specify the backend with a backend key. For example:
backend: pushover
user_key: hunter2
See the backends below for available backends and options.
See the backends below for available backends and options. As of v2.6.0 ``ntfy`` also supports
`3rd party backends <#3rd-party-backends>`_

`Pushover <https://pushover.net>`_ - ``pushover``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -365,6 +366,20 @@ Required parameters:
* ``password`` - login password
* ``room`` - room/channel name to post in

3rd party backends
~~~~~~~~~~~~~~~~~~
To use or implement your own backends, specify the full path of the module as your backend. The
module needs to contain a module with a function called ``notify`` with the following signature:

.. code:: python
def notify(title, message, **kwargs):
"""
kwargs contains retcode if using ntfy done or ntfy shell-integration
and all options in your backend's section of the config
"""
pass
Other options
~~~~~~~~~~~~~
Expand Down

0 comments on commit 9b5e7d2

Please sign in to comment.