Mopidy-Webhooks is a frontend extension for mopidy that sends webhook requests (regular JSON over HTTP POST requests) to a remote server. Mopidy-Webhooks sends a webhook any time mopidy core triggers an event, and also periodically sends player status updates to the remote server.
This is very much a work in progress. Please treat it as such and file issues where appropriate.
Install by running:
pip install Mopidy-Webhooks
Before starting Mopidy, you must add configuration for Mopidy-Webhooks to your Mopidy configuration file:
[webhooks] api_key = my-api-key ; optional api_key_header_name = X-MOPIDY-WEBHOOKS-API-KEY ; optional status_update_interval = 5 ; optional webhook_url = http://localhost:8080/api/webhooks/ ; required
api_key if present, will be sent as a HTTP header using the key
X-MOPIDY-WEBHOOKS-API-KEY. If you'd rather use a different header name, this can be customised with the configuration value
status_update_interval controls the interval between the sending of status update webhooks (in milliseconds). Set to 0 to disable the sending of periodic status updates. If you want continuous status updates, just use a very very small value.
webhook_url should be a URL (accessible to the mopidy client). The provided URL should accept HTTP POST requests, the body of which will contain JSON data. Requests will contain either periodic status updates (currently active track, playback state and time position) or JSON serialised event data emitted by Mopidy core.
- In progress.
- General refactoring
- Small docs improvements
- Initial release.