moodle/local_webhooks
1
Fork 0
Code Actions Releases Activity

docs: document modernization status
Moodle Plugin CI / test (push) Successful in 3m12s
Details

Browse Source
This commit is contained in:
Valentin Popov
2026-08-23 22:25:24 +04:00
parent 82ba9222ff
commit d76637c7c3
1 changed files with 13 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+13 -38
View File
@@ -1,51 +1,26 @@
# Moodle WebHook's # Moodle Webhooks
[![GitHub Release](https://img.shields.io/github/release/valentineus/moodle-webhooks.svg)](https://github.com/valentineus/moodle-webhooks/releases)
[![Build Status](https://travis-ci.org/valentineus/moodle-webhooks.svg?branch=master)](https://travis-ci.org/valentineus/moodle-webhooks)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/376ab669f2d3436884015554f686a915)](https://www.codacy.com/app/valentineus/moodle-webhooks)
[![Gitter Badge](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/valentineus/moodle-webhooks)
Adding Webhooks to Moodle. `local_webhooks` is a Moodle local plugin under active modernization.
The Webhooks feature allows applications to receive real-time notification of changes to certain data.
Using Webhooks, your application will be able to receive notifications of changes to selected topics and their fields. ## Status
Because of this, you do not have to rely on continuous or even periodic requests to check for updates.
Notifications about Webhooks updates are sent as POST requests to the callback URL you specified.
Notifications can indicate the very fact of a field change or include a new value.
Features: [Gitea](https://code.popov.link/moodle/local_webhooks) is the source of truth. GitHub is intentionally a stale mirror.
* Use any number of services for notification; The `develop` branch is unreleased modernization work toward `6.0.0` and is not production-ready. Synchronous delivery and the legacy administration/configuration UI are disabled, so this branch sends no webhook requests.
* Customizing each external service;
* Interception of all events in the Moodle system;
* Use a secret phrase to authenticate requests;
* [JSON](https://en.wikipedia.org/wiki/JSON) - Format of outgoing data;
## Installation ## Current CI baseline
Get the installation package in any of the available methods: Gitea Actions currently tests only Moodle `5.2.2` on PHP `8.4` with PostgreSQL `16`. This is a development baseline, not the final support matrix.
* [GitHub Releases](https://github.com/valentineus/moodle-webhooks/releases). Run the same checks from the repository root with Docker:
* [Compilation from the source code](#build).
## Build
Self-assembly package is as follows:
* Clone the repository:
```bash ```bash
git clone https://github.com/valentineus/moodle-webhooks.git moodle-webhooks export COMPOSE_PROJECT_NAME=local_webhooks_local
``` docker compose build --pull ci
docker compose up --abort-on-container-exit --exit-code-from ci
* Run the build script: docker compose down --volumes --remove-orphans
```bash
cd ./moodle-webhooks
/bin/sh build.sh
``` ```
## License ## License
<img height="256px" alt="GNU Banner" src="https://www.gnu.org/graphics/runfreegnu.png" /> [GNU GPLv3](LICENSE.txt). Copyright (c) [Valentin Popov](mailto:info@valentineus.link).
[GNU GPLv3](LICENSE.txt).
Copyright (c)
[Valentin Popov](mailto:info@valentineus.link).