From 3c4ab345d0811fc7d0666c620ec304fd8ecca403 Mon Sep 17 00:00:00 2001 From: Mateusz Mandera Date: Sun, 5 May 2024 22:38:38 +0200 Subject: [PATCH] webhooks: Rename append-stream-name.md->append-channel-name.md. --- docs/documentation/integrations.md | 2 +- templates/zerver/integrations/include/append-channel-name.md | 3 +++ templates/zerver/integrations/include/append-stream-name.md | 3 --- zerver/webhooks/zendesk/doc.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) create mode 100644 templates/zerver/integrations/include/append-channel-name.md delete mode 100644 templates/zerver/integrations/include/append-stream-name.md diff --git a/docs/documentation/integrations.md b/docs/documentation/integrations.md index f3d9b98261..3f87f4c6bf 100644 --- a/docs/documentation/integrations.md +++ b/docs/documentation/integrations.md @@ -102,7 +102,7 @@ Here are a few common macros used to document Zulip's integrations: every incoming webhook by using attributes in the `WebhookIntegration` class in [zerver/lib/integrations.py][integrations-file]. -- `{!append-stream-name.md!}` macro - Recommends appending `&stream=stream_name` +- `{!append-channel-name.md!}` macro - Recommends appending `&stream=stream_name` to a URL in cases where supplying a stream name in the URL is optional. Supplying a stream name is optional for most Zulip integrations. If you use `{!generate-integration-url.md!}`, this macro need not be used. diff --git a/templates/zerver/integrations/include/append-channel-name.md b/templates/zerver/integrations/include/append-channel-name.md new file mode 100644 index 0000000000..0b3237305c --- /dev/null +++ b/templates/zerver/integrations/include/append-channel-name.md @@ -0,0 +1,3 @@ +To specify the channel, you must explicitly append +`&stream=channel_name` to the end of the above URL, where +`channel_name` is the channel you want the notifications sent to. diff --git a/templates/zerver/integrations/include/append-stream-name.md b/templates/zerver/integrations/include/append-stream-name.md deleted file mode 100644 index 764f32e3c9..0000000000 --- a/templates/zerver/integrations/include/append-stream-name.md +++ /dev/null @@ -1,3 +0,0 @@ -To specify the stream, you must explicitly append -`&stream=stream_name` to the end of the above URL, where -`stream_name` is the stream you want the notifications sent to. diff --git a/zerver/webhooks/zendesk/doc.md b/zerver/webhooks/zendesk/doc.md index 52b3547835..3a82a2be27 100644 --- a/zerver/webhooks/zendesk/doc.md +++ b/zerver/webhooks/zendesk/doc.md @@ -6,7 +6,7 @@ `{{ api_url }}/v1/external/zendesk?ticket_title={% raw %}{{ ticket.title }}&ticket_id={{ ticket.id }}{% endraw %}` -1. {!append-stream-name.md!} +1. {!append-channel-name.md!} 1. Next, in Zendesk, open your **Admin** view via gear in the bottom-left corner. In the **Admin** view, click on **Extensions**, then click