Update webhook doc with screenshots
Signed-off-by: Alexandre Bodin <bodin.alex@gmail.com>
|
Before Width: | Height: | Size: 45 KiB |
BIN
docs/3.0.0-beta.x/assets/concepts/webhooks/create.png
Normal file
|
After Width: | Height: | Size: 300 KiB |
BIN
docs/3.0.0-beta.x/assets/concepts/webhooks/disable.png
Normal file
|
After Width: | Height: | Size: 278 KiB |
BIN
docs/3.0.0-beta.x/assets/concepts/webhooks/home.png
Normal file
|
After Width: | Height: | Size: 280 KiB |
BIN
docs/3.0.0-beta.x/assets/concepts/webhooks/list.png
Normal file
|
After Width: | Height: | Size: 278 KiB |
BIN
docs/3.0.0-beta.x/assets/concepts/webhooks/trigger.png
Normal file
|
After Width: | Height: | Size: 312 KiB |
BIN
docs/3.0.0-beta.x/assets/concepts/webhooks/trigger_result.png
Normal file
|
After Width: | Height: | Size: 304 KiB |
BIN
docs/3.0.0-beta.x/assets/concepts/webhooks/trigger_start.png
Normal file
|
After Width: | Height: | Size: 298 KiB |
@ -9,16 +9,48 @@ The way a webhook works is by delivering informations to a receiving application
|
|||||||
|
|
||||||
## How to use
|
## How to use
|
||||||
|
|
||||||
|
To access the webhook configuration panel, go to `Settings` > `Webhooks`.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
### Create a webhook
|
### Create a webhook
|
||||||
|
|
||||||
### Test a webhook
|
Click on `Add new webhook` and fill in the form.
|
||||||
|
|
||||||
### Enabled and disable a webhook
|

|
||||||
|
|
||||||
|
### Trigger a webhook
|
||||||
|
|
||||||
|
You can test out a webhook with a test event: `trigger-test`. Open the webhook you want to trigger:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Click on the `Trigger` button.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
You will see the trigger request appear and get the result.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Enable and disable a webhook
|
||||||
|
|
||||||
|
You can enable or disable a webhook from the list view directly
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
### Update a webhook
|
### Update a webhook
|
||||||
|
|
||||||
|
You can edit any webhook by clicking on the `pen` icon in the webhook list view.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
### Delete a webhook
|
### Delete a webhook
|
||||||
|
|
||||||
|
You can delete a webhook by clicking on the `trash` icon.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## Available events
|
## Available events
|
||||||
|
|
||||||
By default strapi webhook can be trigger by the following 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
|
## Developer documentation
|
||||||
|
|
||||||
### Architecture
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Available configurations
|
### Available configurations
|
||||||
|
|
||||||
You can set webhooks configurations inside the file `./config/environments/{env}/server.json`.
|
You can set webhooks configurations inside the file `./config/environments/{env}/server.json`.
|
||||||
|
|||||||