diff options
Diffstat (limited to 'doc/user/project/integrations/webhooks.md')
| -rw-r--r-- | doc/user/project/integrations/webhooks.md | 24 |
1 files changed, 21 insertions, 3 deletions
diff --git a/doc/user/project/integrations/webhooks.md b/doc/user/project/integrations/webhooks.md index 9fc9d6e2eda..ef6957ac2d8 100644 --- a/doc/user/project/integrations/webhooks.md +++ b/doc/user/project/integrations/webhooks.md @@ -115,6 +115,15 @@ a test request to re-enable a [disabled webhook](#re-enable-disabled-webhooks). For example, to test `push events`, your project should have at least one commit. The webhook uses this commit in the webhook. +NOTE: +Testing is not supported for some types of events for project and groups webhooks. +Read more in [issue 379201](https://gitlab.com/gitlab-org/gitlab/-/issues/379201). + +Prerequisites: + +- To test project webhooks, you must have at least the Maintainer role for the project. +- To test group webhooks, you must have the Owner role for the group. + To test a webhook: 1. In your project or group, on the left sidebar, select **Settings > Webhooks**. @@ -177,9 +186,13 @@ that the request is legitimate. ## Filter push events by branch -Push events can be filtered by branch using a branch name or wildcard pattern -to limit which push events are sent to your webhook endpoint. By default, -all push events are sent to your webhook endpoint. You can configure branch filtering +You can filter push events by branch. Use one of the following options to filter which push events are sent to your webhook endpoint: + +- **All branches**: push events from all branches. +- **Wildcard pattern**: push events from a branch that matches a wildcard pattern (for example, `*-stable` or `production/*`). +- **Regular expression**: push events from a branch that matches a regular expression (for example, `(feature|hotfix)/*`). + +You can configure branch filtering in the [webhook settings](#configure-a-webhook-in-gitlab) in your project. ## How image URLs are displayed in the webhook body @@ -233,6 +246,11 @@ Webhook requests to your endpoint include the following headers: GitLab records the history of each webhook request. You can view requests made in the last 2 days in the **Recent events** table. +Prerequisites: + +- To troubleshoot project webhooks, you must have at least the Maintainer role for the project. +- To troubleshoot group webhooks, you must have the Owner role for the group. + To view the table: 1. In your project or group, on the left sidebar, select **Settings > Webhooks**. |