snapshot of https://github.com/zulip/zulip.git @ 48c69911c7dd4e03b20552eb3bd77ad8151c1357 (2026-09-15)

templates/zerver/integrations/include/change-zulip-config-file.md

@@ -0,0 +1,9 @@
+Open `{{ config_file_path}}` with your favorite editor, and change the
+following lines to specify the email address and API key for your
+{{ integration_display_name }} bot:
+
+```
+ZULIP_USER = "{{ integration_name }}-bot@{{ display_host }}"
+ZULIP_API_KEY = "0123456789abcdef0123456789abcdef"
+ZULIP_SITE = "{{ zulip_url }}"
+```

templates/zerver/integrations/include/congrats.md

@@ -0,0 +1,2 @@
+You're done! Your {{ integration_display_name }} notifications may look like
+this:

templates/zerver/integrations/include/create-a-generic-bot.md

@@ -0,0 +1,3 @@
+[Create a bot](/help/add-a-bot-or-integration) for
+{{ integration_display_name }}. Make sure that you select
+**Generic bot** as the **Bot type**.

templates/zerver/integrations/include/create-an-incoming-webhook.md

@@ -0,0 +1,3 @@
+[Create a bot](/help/add-a-bot-or-integration) for
+{{ integration_display_name }}. Make sure that you select
+**Incoming webhook** as the **Bot type**.

templates/zerver/integrations/include/create-channel.md

@@ -0,0 +1,2 @@
+[Create the channel](/help/create-a-channel) you'd like to use for
+{{ integration_display_name }} notifications.

templates/zerver/integrations/include/download-python-bindings.md

@@ -0,0 +1,4 @@
+Download and install our
+[Python bindings and example scripts](/api/installation-instructions)
+on the system where the {{ integration_display_name }} integration script
+will be run from.

templates/zerver/integrations/include/event-filtering-additional-feature.md

@@ -0,0 +1,10 @@
+### Filtering incoming events
+
+The {{ integration_display_name }} integration supports
+[filtering][event-filters] for the following events:
+
+{% set comma = joiner(", ") %}
+
+{% for event_type in all_event_types -%} {{- comma() -}} `{{ event_type }}` {%- endfor %}
+
+[event-filters]: https://zulip.readthedocs.io/en/latest/webhooks/incoming-webhooks-overview.html#only-events-exclude-events

templates/zerver/integrations/include/event-filtering-instruction.md

@@ -0,0 +1,6 @@
+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 %}

templates/zerver/integrations/include/generate-webhook-url-basic.md

@@ -0,0 +1,2 @@
+Decide where to send {{ integration_display_name }} notifications, and
+[generate the integration URL](/help/generate-integration-url).

templates/zerver/integrations/include/generate-webhook-url-with-branch-filtering.md

@@ -0,0 +1,3 @@
+Decide where to send {{ integration_display_name }} notifications, and
+[generate the integration URL](/help/generate-integration-url). You'll be
+able to configure which branches you'll receive notifications from.

templates/zerver/integrations/include/install-requirements.md

@@ -0,0 +1,3 @@
+Install the dependencies for the integration with:
+
+`pip install -r {{ integration_path }}/requirements.txt`

templates/zerver/integrations/include/webhook-url-with-bot-email.md

@@ -0,0 +1,13 @@
+Construct the URL for the {{ integration_display_name }}
+bot using the bot's API key and email address:
+
+`{{ external_url_scheme }}bot_email:bot_api_key@{{ api_url_scheme_relative }}{{ integration_url }}`
+
+Modify the parameters of the URL above, where `bot_email` is
+the bot's URL-encoded email address and `bot_api_key` is the
+bot's API key.  To URL-encode the email address, you just need
+to replace `@` in the bot's email address with `%40`.
+
+You can also limit the branches you receive notifications for by
+specifying them in a comma-separated list appended to the end of the
+URL, e.g., `&branches=main,development`.

templates/zerver/integrations/include/webhooks-url-specification.md

@@ -0,0 +1,3 @@
+* [Webhook URLs specification][incoming-webhook-urls]
+
+[incoming-webhook-urls]: https://zulip.readthedocs.io/en/latest/webhooks/incoming-webhooks-overview.html#url-specification