documentation for webhooks on projects

[ci skip]
pull/8763/head
ML-OpenP 4 years ago
parent b5047d70c4
commit 3b4ea7916d
  1. 12
      docs/system-admin-guide/webhooks/README.md
  2. BIN
      docs/system-admin-guide/webhooks/image-20201007133753887.png
  3. BIN
      docs/system-admin-guide/webhooks/image-20201007140523324.png

@ -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)
![Add new webhook screenshot](image-20201007140523324.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 434 KiB

Loading…
Cancel
Save