aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 15 insertions, 4 deletions
diff --git a/README.md b/README.md
index 171d7a8..c8fcae6 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,23 @@
[![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/auth-link)
+[![Gitter Badge](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/valentineus/moodle-webhooks)
-Webhooks allow applications to subscribe to Moodle events.
+Adding Webhooks to Moodle.
+The Webhooks feature allows applications to receive real-time notification of changes to certain data.
-**Attention!**:
-This plugin is in active development.
+Using Webhooks, your application will be able to receive notifications of changes to selected topics and their fields.
+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:
+
+* Use any number of services for notification;
+* 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