Matterbridge webhooks plugin

!Node.js CI
!CodeQL


---

This plugin allows you to expose single webhooks or complex webhook devices to Matter.

Simple webhooks

Features:

- The webhooks parameters can easily be entered in the frontend.
- It is possible to choose how to expose the webhooks: Switch, Outlet or Light.
- It is possible to choose the method: GET or POST.
- The webhook can be tested in the frontend.

Webhook devices

Features:

- It is possible to choose the device type from the config.
- It is possible to set the method with a prefix 'GET#' or 'POST# in the urls. Default if omitted is GET.
- It is possible to use converters and attributes in the url.

Supported device types:

| Device type | Urls |
| -------------- | ------------------------------------ |
| outlet | on off |
| onOffLight | on off |
| dimmerLight | on off brightness |
| colorTempLight | on off brightness colorTemp |
| extendedLight | on off brightness colorTemp colorRgb |

If there is interest, let me know and I will add all other device types.

Supported request converters:

| Converter | Return value |
| ------------- | ------------------- |
| ${LEVEL} | matter 1-254 |
| ${LEVEL100} | percentage 0-100 |
| ${MIRED} | colorTemp in mired |
| ${KELVIN} | colorTemp in kelvin |
| ${HUE} | hue 0-360 |
| ${SATURATION} | saturation 0-100 |
| ${COLORX} | colorX 0-1 |
| ${COLORY} | colorX 0-1 |

Supported cluster attributes:

| Attributes | Return value |
| ------------- | ------------------- |
| ${level} | matter 1-254 |
| ${level100} | percentage 0-100 |
| ${mired} | colorTemp in mired |
| ${kelvin} | colorTemp in kelvin |
| ${hue} | hue 0-360 |
| ${saturation} | saturation 0-100 |
| ${colorX} | colorX 0-1 |
| ${colorY} | colorX 0-1 |
| ${red} | red 0-255 |
| ${gree} | green 0-255 |
| ${blue} | blue 0-255 |

If you like this project and find it useful, please consider giving it a star on GitHub and sponsoring it.

Prerequisites

$3

See the complete guidelines on Matterbridge for more information.

How to add a simple webhook

In the frontend open the plugin config: add a new webhook, enter the webhook name in the first field (replace newKey with the name you want to give to the webhook), select GET or POST and enter the webhook url. The webhook name will be the device name on the controller. The webhook will be exposed like a switch, like an outlet or like a light. When you turn it on, the webhook is called and in a few seconds the switch or the outlet or the light will revert to off.

It is possible to test directly the webhook from the config editor.

Examples

Shelly webhooks examples

Change 192.168.1.XXX with your device IP address.

$3

To turn on a shelly gen 1 device with ip 192.168.1.155 the url is http://192.168.1.XXX/light/0?turn=on.

To turn off a shelly gen 1 device with ip 192.168.1.155 the url is http://192.168.1.XXX/light/0?turn=off.

$3

The following examples allows to fully control a Shelly Trv Gen 1, adding Boost, Schedule and Profile (provided by https://github.com/vandan380).

"Boost 30min": method: POST, Url: "http://192.168.1.XXX/thermostats/0?boost_minutes=30"

"Schedule Enable": method: POST, Url: "http://192.168.1.XXX/settings/thermostats/0?schedule=1"

"Schedule Disable": method: POST, Url: "http://192.168.1.XXX/settings/thermostats/0?schedule=0"

"Profile Working Day": method: POST, Url: "http://192.168.1.XXX/settings/thermostats/0?schedule_profile=1"

"Profile Holiday": method: POST, Url: "http://192.168.1.XXX/settings/thermostats/0?schedule_profile=2"