diff options
| author | Valentin Popov <info@valentineus.link> | 2017-12-11 06:43:17 +0300 |
|---|---|---|
| committer | Valentin Popov <info@valentineus.link> | 2017-12-11 06:43:17 +0300 |
| commit | 7278ee951bd8b62fea96b59ad79be694088e7849 (patch) | |
| tree | a3f71335232e40ef017098107aa3fc9a075f30c9 | |
| parent | 01e2ba9f2f4622b0aeeece9009acb09d8a433883 (diff) | |
| download | local_webhooks-7278ee951bd8b62fea96b59ad79be694088e7849.tar.xz local_webhooks-7278ee951bd8b62fea96b59ad79be694088e7849.zip | |
Changes to the User's Guide
| -rw-r--r-- | docs/getting-started.md | 27 |
1 files changed, 12 insertions, 15 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md index ef6fa5d..a70e09c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -2,12 +2,12 @@ ## Navigation -* Installation - * Build -* User guide - * Guide to the manager - * Guide to the editor -* Request format +* [Installation](#installation) + * [Build](#build) +* [User guide](#user-guide) + * [Guide to the manager](#guide-to-the-manager) + * [Guide to the editor](#guide-to-the-editor) +* [Request format](#request-format) ## Installation @@ -64,16 +64,13 @@ During the editing and creation of the service, this page opens:  -The field "**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. - -The "**Token**" field allows you to specify an individual key that will allow an external service to identify requests. - -The "**Advanced**" field stores a large string passed to the service. +Description of fields: +* "**Name**" stores an arbitrary name for the service. +* "**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. +* "**Advanced**" stores a large string passed to the service. This can be useful for some services or users. - -The "**Content Type**" field allows you to configure the type of outbound requests if there are compatibility issues. +* "**Content Type**" 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 selected events will notify the service. |