mqtt-tools/mqttwarn

[Webhook] Implement new service plugin

Open

#306 opened on Apr 12, 2018

View on GitHub
 (3 comments) (2 reactions) (0 assignees)Python (930 stars) (184 forks)batch import
enhancementhelp wantedservice plugin

Description

We want a webhook service. It should have configurable headers it can send on outgoing POST and of course a configurable/templateable payload.

I'm thinking along the lines of MQTT publish to mqttwarn to Webhook to trigger whatever.

Contributor guide

Tech stack
pythonrest api
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Python programmingHTTP POST basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Start by reviewing the existing service plugins in the `services/` directory to understand the plugin interface and configuration. Implement a new `WebhookService` class that accepts a target URL, headers dictionary, and a payload template. Use the `requests` library for HTTP POST. Ensure to add comprehensive tests and update the documentation. Check the issue comments for any additional requirements.