mirror of https://github.com/zulip/zulip.git
docs: Update integration URL generation documentation.
Co-authored-by: Lauryn Menard <lauryn@zulip.com> Co-authored-by: Alya Abbott <alya@zulip.com>
This commit is contained in:
parent
6ee354ddd6
commit
8cae09abd6
|
@ -24,6 +24,9 @@ integration URL.
|
||||||
1. _(optional)_ Select **Send all notifications to a single topic**, and
|
1. _(optional)_ Select **Send all notifications to a single topic**, and
|
||||||
enter the topic name.
|
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.
|
1. Click **Copy URL** to add the URL to your clipboard.
|
||||||
|
|
||||||
!!! tip ""
|
!!! tip ""
|
||||||
|
@ -50,6 +53,9 @@ integration URL.
|
||||||
1. _(optional)_ Select **Send all notifications to a single topic**, and
|
1. _(optional)_ Select **Send all notifications to a single topic**, and
|
||||||
enter the topic name.
|
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.
|
1. Click **Copy URL** to add the URL to your clipboard.
|
||||||
|
|
||||||
{end_tabs}
|
{end_tabs}
|
||||||
|
|
|
@ -1,14 +1,6 @@
|
||||||
To filter the events that trigger the notifications, you can append
|
You will be able to configure which of the following
|
||||||
either `&only_events=["event_a","event_b"]` or `&exclude_events=["event_a","event_b"]`
|
{{ integration_display_name }} events trigger notifications:
|
||||||
(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:
|
|
||||||
|
|
||||||
{% set comma = joiner(", ") %}
|
{% set comma = joiner(", ") %}
|
||||||
|
|
||||||
{% for event_type in all_event_types -%} {{- comma() -}} `{{ event_type }}` {%- endfor %}
|
{% 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`.
|
|
||||||
|
|
|
@ -1,18 +1,18 @@
|
||||||
[Generate the URL][generate-url] for your {{ integration_display_name }}
|
[Generate the URL][generate-url] for your {{ integration_display_name }}
|
||||||
integration.
|
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 %}
|
{% if all_event_types is defined %}
|
||||||
|
|
||||||
{!event-filtering-instruction.md!}
|
{!event-filtering-instruction.md!}
|
||||||
|
|
||||||
{% endif %}
|
{% 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
|
[generate-url]: /help/generate-integration-url
|
||||||
[incoming-webhook-urls]: /api/incoming-webhooks-overview#urls
|
[incoming-webhook-urls]: /api/incoming-webhooks-overview#urls
|
||||||
|
|
Loading…
Reference in New Issue