Update webhook doc with screenshots

Signed-off-by: Alexandre Bodin <bodin.alex@gmail.com>
This commit is contained in:
Alexandre Bodin 2020-01-20 18:01:01 +01:00
parent 3fa75d78b9
commit 6986948c81
9 changed files with 34 additions and 6 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 300 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 278 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 280 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 278 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 312 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 304 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 298 KiB

View File

@ -9,16 +9,48 @@ The way a webhook works is by delivering informations to a receiving application
## How to use
To access the webhook configuration panel, go to `Settings` > `Webhooks`.
![Webhooks home](../assets/concepts/webhooks/home.png)
### Create a webhook
### Test a webhook
Click on `Add new webhook` and fill in the form.
### Enabled and disable a webhook
![create](../assets/concepts/webhooks/create.png)
### Trigger a webhook
You can test out a webhook with a test event: `trigger-test`. Open the webhook you want to trigger:
![Trigger ](../assets/concepts/webhooks/trigger_start.png)
Click on the `Trigger` button.
![Trigger pending](../assets/concepts/webhooks/trigger.png)
You will see the trigger request appear and get the result.
![Trigger result](../assets/concepts/webhooks/trigger_result.png)
### Enable and disable a webhook
You can enable or disable a webhook from the list view directly
![Disable webhook](../assets/concepts/webhooks/disable.png)
### Update a webhook
You can edit any webhook by clicking on the `pen` icon in the webhook list view.
![Update webhook](../assets/concepts/webhooks/list.png)
### Delete a webhook
You can delete a webhook by clicking on the `trash` icon.
![Delete webhook](../assets/concepts/webhooks/disable.png)
## Available events
By default strapi webhook can be trigger by the following events:
@ -177,10 +209,6 @@ This event is triggered only when you delete a media through the media interface
## Developer documentation
### Architecture
![Webhooks architecture diagram](../assets/concepts/diagram-architecture.png)
### Available configurations
You can set webhooks configurations inside the file `./config/environments/{env}/server.json`.