Skip to content

Commit ecc2cde

Browse files
authored
Merge pull request #7 from teams-notifier/doc-gitlab-br-api-filter_on_participant_ids
doc(gitlab-mr-api): add `filter_on_participant_ids` documentantion
2 parents 2807afb + 4c13df2 commit ecc2cde

File tree

1 file changed

+5
-2
lines changed
  • content/docs/deployment/addons/gitlab-mr-api

1 file changed

+5
-2
lines changed

content/docs/deployment/addons/gitlab-mr-api/index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,11 @@ On your GitLab repository, follow these steps to add a new webhook:
4949
3. Click **Add new webhook**.
5050
4. Fill out the form with the following details:
5151

52-
* **URL**: https://hostname-of-this-api.example.org/api/v1/gitlab-webhook
52+
* **URL**: https://hostname-of-this-api.example.org/api/v1/gitlab-webhook \
53+
{{< callout type="info" >}}
54+
Since v0.12.0, you can specify a filter to publish notifications only if certain users are involved as the opener, reviewers, or assignees. Use query parameters `filter_on_participant_ids` with a comma-separated list of user IDs (integers).
55+
{{< /callout >}}
56+
5357
* **Add custom header**:
5458
* name: `X-Conversation-Token`
5559
* value: comma separated list of conversation tokens you want the MR messages sent to
@@ -64,7 +68,6 @@ Note that for the test to work you need an existing MR in the project.
6468

6569
In case of failure, now or afterward, you can Edit the webhook and you'll see all the previous calls, error code and messages, including sent payload and a way to resend the request.
6670

67-
6871
## Webhook declaration helper
6972

7073
{{% details title="Environment variables" %}}

0 commit comments

Comments
 (0)