moodle/local_webhooks
0
Fork 0
Code Issues Releases Activity

Changes to the User's Guide

Browse Source
This commit is contained in:
Valentin Popov 2017-12-11 07:43:17 +04:00
parent 01e2ba9f2f
commit 7278ee951b
1 changed files with 12 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/getting-started.md
View File

@ -2,12 +2,12 @@
## Navigation ## Navigation
* Installation * [Installation](#installation)
* Build * [Build](#build)
* User guide * [User guide](#user-guide)
* Guide to the manager * [Guide to the manager](#guide-to-the-manager)
* Guide to the editor * [Guide to the editor](#guide-to-the-editor)
* Request format * [Request format](#request-format)
## Installation ## Installation
@ -64,16 +64,13 @@ During the editing and creation of the service, this page opens:
![Service Editor](screenshots/editservice.jpg) ![Service Editor](screenshots/editservice.jpg)
The field "**Name**" stores an arbitrary name for the service Description of fields:
* "**Name**" stores an arbitrary name for the service.
The "**URL**" field stores the address of the service to which notifications will be sent as a POST request. * "**URL**" stores the address of the service to which notifications will be sent as a POST request.
* "**Token**" allows you to specify an individual key that will allow an external service to identify requests.
The "**Token**" field allows you to specify an individual key that will allow an external service to identify requests. * "**Advanced**" stores a large string passed to the service.
The "**Advanced**" field stores a large string passed to the service.
This can be useful for some services or users. This can be useful for some services or users.
* "**Content Type**" allows you to configure the type of outbound requests if there are compatibility issues.
The "**Content Type**" field allows you to configure the type of outbound requests if there are compatibility issues.
The "**All events**" list contains a list of all events registered in the system. The "**All events**" list contains a list of all events registered in the system.
The selected events will notify the service. The selected events will notify the service.