OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
openproject/docs/system-admin-guide/webhooks/README.md

34 lines
1.6 KiB

---
sidebar_navigation:
title: Webhooks
priority: 600
description: Configure webhooks in OpenProject.
robots: index, follow
keywords: webhooks
---
# Webhooks
You can set up webhooks for OpenProject in order to integrate OpenProject with other applications. A scenario is for example to signal the creation of a time log in OpenProject to a billing application.
Navigate to -> *Administration* -> *Webhooks* to set up your webhooks in OpenProject.
Press the green **+ Webhook** button to add a new webhook to OpenProject.
![image-20201007133753887](image-20201007133753887.png)
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 additional **description** to further identify the intent of the respective webhook.
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.
![Add new webhook screenshot](image-20201007140523324.png)