README.rst 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. ****************
  2. Mopidy-Webhooks
  3. ****************
  4. .. image:: https://img.shields.io/pypi/v/Mopidy-Webhooks
  5. :target: https://pypi.org/project/Mopidy-Webhooks/
  6. :alt: Latest PyPI version
  7. `Mopidy <https://www.mopidy.com/>`_ extension for sending mopidy play status to
  8. arbitrary URL endpoints
  9. Installation
  10. ============
  11. Install by running::
  12. sudo python3 -m pip install Mopidy-Webhooks
  13. Configuration
  14. =============
  15. To enable this extension, make sure to add the following variables to your
  16. Mopidy configuration file. Note that multiple URLs can be sent to by separating
  17. them with a comma. Tokens match the listing of urls::
  18. [webhooks]
  19. enabled = true
  20. urls = https://example.com/api/receiver/,http://127.0.0.1:8000/webhook/
  21. tokens = ,2349080989234089
  22. The following configuration values are available:
  23. - ``webhooks/enabled``: If the webhooks extension should be enabled or not.
  24. Defaults to disabled.
  25. - ``webhooks/urls``: Comma-separated list of endpoints to send play data to
  26. - ``webhooks/tokens``: Comma-separated list of tokens to send in the
  27. Authorization header for each URL
  28. Project resources
  29. =================
  30. - `Source code <https://github.com/powellc/mopidy-webhooks>`_
  31. - `Issue tracker <https://github.com/powellc/mopidy-webhooks/issues>`_
  32. - `Changelog <https://github.com/powellc/mopidy-webhooks/releases>`_
  33. Credits
  34. =======
  35. - Author: `Colin Powell <https://github.com/powellc>`__