Skip to main content
Latest PyPI version Number of PyPI downloads Github Actions CI build status

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.

Installation

Install by running:

pip install Mopidy-Webhooks

Configuration

Before starting Mopidy, you must add configuration for Mopidy-Webhooks to your Mopidy configuration file:

[webhooks]
webhook_url = http://localhost:8080/api/webhooks/ ; required
api_key = my-api-key                              ; optional
api_key_header_name = X-MOPIDY-WEBHOOKS-API-KEY   ; optional
status_update_interval = 1000                     ; optional

webhook_url should be a URL (accessible to the Mopidy server). The provided URL must 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.

api_key and api_key_header_name must both be specified together for the header to be sent.

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.

Project resources

Release files for Mopidy-Webhooks 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for Mopidy-Webhooks 1.0.1
File Size Uploaded
Mopidy-Webhooks-1.0.1.tar.gz 11.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for Mopidy-Webhooks 1.0.1
File Interpreter ABI Platform
Mopidy_Webhooks-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 21.6 kB

Release files / Mopidy-Webhooks-1.0.1.tar.gz

Download URL Mopidy-Webhooks-1.0.1.tar.gz
Size 11.0 kB
Tags Source
SHA-256 checksum
How to use checksums
d79d7bf628ba0bb7f3d3c5c0f4277e234084e2c8015813e006a9e236369a06d7
BLAKE2b-256 checksum
How to use checksums
bbd78fe73d5f84789b015910019e6f4ae9c2939fec96ab98889b9a81b7938655
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

Release files / Mopidy_Webhooks-1.0.1-py3-none-any.whl

Download URL Mopidy_Webhooks-1.0.1-py3-none-any.whl
Size 10.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
33ca115583a7933fb7b76a05daf6e3a0559f5a8ca966ba5fd8b033c575888e1c
BLAKE2b-256 checksum
How to use checksums
426452afdaab9bac2266db7df62789c304110eb754b7d67322e7e92469c37c23
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

1.0.0

2 release files

0.2.0

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page