From 8cae09abd6fc0c38b7211f2574f84887669a60eb Mon Sep 17 00:00:00 2001 From: sujal Date: Tue, 19 Dec 2023 23:38:57 +0530 Subject: [PATCH] docs: Update integration URL generation documentation. Co-authored-by: Lauryn Menard Co-authored-by: Alya Abbott --- help/generate-integration-url.md | 6 ++++++ .../include/event-filtering-instruction.md | 12 ++---------- .../include/generate-integration-url.md | 14 +++++++------- 3 files changed, 15 insertions(+), 17 deletions(-) diff --git a/help/generate-integration-url.md b/help/generate-integration-url.md index ec3e4eb5ac..7b14812773 100644 --- a/help/generate-integration-url.md +++ b/help/generate-integration-url.md @@ -24,6 +24,9 @@ integration URL. 1. _(optional)_ Select **Send all notifications to a single topic**, and enter the topic name. +1. _(optional)_ Select **Filter events that will trigger notifications?**, + and select which supported events should trigger notifications. + 1. Click **Copy URL** to add the URL to your clipboard. !!! tip "" @@ -50,6 +53,9 @@ integration URL. 1. _(optional)_ Select **Send all notifications to a single topic**, and enter the topic name. +1. _(optional)_ Select **Filter events that will trigger notifications?**, + and select which supported events should trigger notifications. + 1. Click **Copy URL** to add the URL to your clipboard. {end_tabs} diff --git a/templates/zerver/integrations/include/event-filtering-instruction.md b/templates/zerver/integrations/include/event-filtering-instruction.md index 9d202a0faa..08c67ca243 100644 --- a/templates/zerver/integrations/include/event-filtering-instruction.md +++ b/templates/zerver/integrations/include/event-filtering-instruction.md @@ -1,14 +1,6 @@ -To filter the events that trigger the notifications, you can append -either `&only_events=["event_a","event_b"]` or `&exclude_events=["event_a","event_b"]` -(or both, with different events) to the URL you generated with an arbitrary -number of supported events. - -Below are the events that {{ integration_display_name }} bot supports: +You will be able to configure which of the following +{{ integration_display_name }} events trigger notifications: {% set comma = joiner(", ") %} {% for event_type in all_event_types -%} {{- comma() -}} `{{ event_type }}` {%- endfor %} - -Note that you can also use UNIX-style wildcards like `*` to include -multiple events. E.g., `test*` matches every event that starts with -`test`. diff --git a/templates/zerver/integrations/include/generate-integration-url.md b/templates/zerver/integrations/include/generate-integration-url.md index affe88412b..5ae3585865 100644 --- a/templates/zerver/integrations/include/generate-integration-url.md +++ b/templates/zerver/integrations/include/generate-integration-url.md @@ -1,18 +1,18 @@ [Generate the URL][generate-url] for your {{ integration_display_name }} integration. -The generated URL will be something like: - -{!webhook-url.md!} - -*To manually construct the URL for an incoming webhook integration, -see [the webhook URLs specification][incoming-webhook-urls].* - {% if all_event_types is defined %} {!event-filtering-instruction.md!} {% endif %} +The generated URL will look something like this: + +{!webhook-url.md!} + +*To manually construct the URL for an incoming webhook integration, +see [the webhook URLs specification][incoming-webhook-urls].* + [generate-url]: /help/generate-integration-url [incoming-webhook-urls]: /api/incoming-webhooks-overview#urls