hookplate 0.1.13

No project description provided

hookplate

Matrix appservice for creating webhook endpoints and sending webhook messages to matrix rooms

• simple webservice that forwards webhook messages after formatting
• simple jinja template can be used to format messages
• webhook url creation and deletion through controll room
• creates controll and output room on startup

Configuration

Either by config.ini or env variables. Env variables take precedence. Rename sample_config.ini to config.ini and set every config value.

Environment variable	Config file name	Example value
HOMESERVER_URL	homeserver_url	https://matrix.domain.com
ADMIN_USER	admin_user	@admin:matrix.domain.com
APPSERVICE_USER	appservice_user	@webhook:matrix.domain.com
TOKEN	token	syt_d2VgfG9eqr_dbvTrKgfDerOdseFMZNP_0z99KM
DEVICE_ID	device_id	AABBCCDDEE

Install/Run

Only if you run it non virtualized. You need python ">=3.13"

python -m venv .venv
source .venv/bin/activate
python -m pip install hookplate
hookplate

Docker

docker run -d --rm \
  --name hookplate \
  -v /on/host/appservice/config:/app/config \
  -p 8228:8228 \
  docker.io/hidraulicchicken/hookplate

Controll room commands

Command	Explanation
!webhook help	Show help message
!webhook list	List all webhooks
!webhook add [name]	Add a webhook with given name
!webhook remove [name]	Remove webhook with given name

Development

Python packages are handled by uv, but if you prefer, look into pyproject.toml and install dependencies yourself.

git clone https://github.com/hidraulicChicken/hookplate.git
cd hookplate
curl -LsSf https://astral.sh/uv/install.sh | sh
uv venv --python 3.13.0
uv pip install -e .

Contribution

If you have jinja template for certain services webhooks, let me know in the issues page.