diff --git a/docs/system-admin-guide/webhooks/README.md b/docs/system-admin-guide/webhooks/README.md index 5c9391c42c..fda0237fbf 100644 --- a/docs/system-admin-guide/webhooks/README.md +++ b/docs/system-admin-guide/webhooks/README.md @@ -14,7 +14,7 @@ Navigate to -> *Administration* -> *Webhooks* to set up your webhooks in OpenPro Press the green **+ Webhook** button to add a new webhook to OpenProject. -![Sys-admin-webhooks](Sys-admin-webhooks.png) +![image-20201007133753887](image-20201007133753887.png) @@ -23,10 +23,12 @@ You can configure the following options for webhooks: 1. Choose a **name** identifying the webhook. 2. **Payload URL** defines the endpoint, called when the webhook is triggered. 3. Freely choose an additonal **description** to further identify the intent of the respective webhook. -4. By defining a **Siganture secret** you guarantee that the sender of the payload request is actually OpenProject. The client will then check this signature secret. -5. Enable if the webhook should be active. -6. Set the events for which the webhook should be activate, i.e. webhook for updating or creating work packages, or for creating time entries. +4. By defining a **Signature secret** you guarantee that the sender of the payload request is actually OpenProject. The client will then check this signature secret. +5. **Enable** if **the webhook** should be active. +6. **Set the events** for which the webhook should be activate, i.e. webhook for updating or creating projects or work packages, or for creating time entries. 7. **Select for which projects the webhook should be active**. You can choose all projects or only specific projects. For example if you select the project "System admin guide", an event (ie. create a new time entry) will be fired via the webhook. This will only happen if a user logs time within the selected projects. 8. Press the blue **Create** button to save your changes. -![Sys-admin-webhooks-configuration](Sys-admin-webhooks-configuration.png) \ No newline at end of file + + +![Add new webhook screenshot](image-20201007140523324.png) \ No newline at end of file diff --git a/docs/system-admin-guide/webhooks/image-20201007133753887.png b/docs/system-admin-guide/webhooks/image-20201007133753887.png new file mode 100644 index 0000000000..5bc62398e2 Binary files /dev/null and b/docs/system-admin-guide/webhooks/image-20201007133753887.png differ diff --git a/docs/system-admin-guide/webhooks/image-20201007140523324.png b/docs/system-admin-guide/webhooks/image-20201007140523324.png new file mode 100644 index 0000000000..456fc331a7 Binary files /dev/null and b/docs/system-admin-guide/webhooks/image-20201007140523324.png differ