From 87007df8eb79b327ce946e8d64fc8b8a63bf619f Mon Sep 17 00:00:00 2001 From: Mateusz Mandera Date: Mon, 6 May 2024 02:25:47 +0200 Subject: [PATCH] webhooks: Rename remaining stream references to channel. Note: This doesn't change the occurences in the Zapier integration doc, since they refer to pieces of the UI in Zapier, which may still be using the "Stream" terminology. --- zerver/webhooks/buildbot/doc.md | 2 +- zerver/webhooks/deskdotcom/doc.md | 6 +++--- zerver/webhooks/helloworld/doc.md | 8 ++++---- zerver/webhooks/homeassistant/doc.md | 2 +- zerver/webhooks/newrelic/doc.md | 2 +- zerver/webhooks/opencollective/doc.md | 2 +- zerver/webhooks/slack/doc.md | 12 ++++++------ zerver/webhooks/splunk/doc.md | 4 ++-- zerver/webhooks/zendesk/doc.md | 2 +- 9 files changed, 20 insertions(+), 20 deletions(-) diff --git a/zerver/webhooks/buildbot/doc.md b/zerver/webhooks/buildbot/doc.md index 5ff0bbaff1..b14b6a3712 100644 --- a/zerver/webhooks/buildbot/doc.md +++ b/zerver/webhooks/buildbot/doc.md @@ -19,7 +19,7 @@ Get Zulip notifications for your Buildbot builds! c['services'].append(zs) When adding the new reporter, modify the code above such that `api_key` - is the API key of your Zulip bot, and `stream` is set to the stream name + is the API key of your Zulip bot, and `stream` is set to the channel name you want the notifications sent to. [1]: https://docs.buildbot.net/latest/manual/configuration/reporters/zulip_status.html diff --git a/zerver/webhooks/deskdotcom/doc.md b/zerver/webhooks/deskdotcom/doc.md index a36131739d..c6e6169e2b 100644 --- a/zerver/webhooks/deskdotcom/doc.md +++ b/zerver/webhooks/deskdotcom/doc.md @@ -1,6 +1,6 @@ 1. {!create-channel.md!} - Keep in mind you still need to create the stream first even + Keep in mind you still need to create the channel first even if you are using this recommendation. 1. {!create-an-incoming-webhook.md!} @@ -42,7 +42,7 @@ {% endraw %} The "appended URL path" will be the same for every notification — - it makes sure the notification goes to the appropriate stream and topic + it makes sure the notification goes to the appropriate channel and topic within Zulip. 1. Next, copy this template Zulip message into **Message to POST**: @@ -102,4 +102,4 @@ ![](/static/images/integrations/desk/009.png) When a case is updated, you'll see a notification like the one above, -to the stream `desk`, with a topic that matches the case's subject name. +to the channel `desk`, with a topic that matches the case's subject name. diff --git a/zerver/webhooks/helloworld/doc.md b/zerver/webhooks/helloworld/doc.md index 36158e81d8..84b5ba5919 100644 --- a/zerver/webhooks/helloworld/doc.md +++ b/zerver/webhooks/helloworld/doc.md @@ -3,9 +3,9 @@ Learn how Zulip integrations work with this simple Hello World example! This webhook is Zulip's official [example integration](/api/incoming-webhooks-walkthrough). -1. The Hello World webhook will use the `test` stream, which is created +1. The Hello World webhook will use the `test` channel, which is created by default in the Zulip development environment. If you are running - Zulip in production, you should make sure that this stream exists. + Zulip in production, you should make sure that this channel exists. 1. {!create-an-incoming-webhook.md!} @@ -19,13 +19,13 @@ integration](/api/incoming-webhooks-walkthrough). (zulip-py3-venv) vagrant@vagrant:/srv/zulip$ ./manage.py send_webhook_fixture_message \ > --fixture=zerver/tests/fixtures/helloworld/hello.json \ - > '--url=http://localhost:9991/api/v1/external/helloworld?api_key=abcdefgh&stream=stream%20name;' + > '--url=http://localhost:9991/api/v1/external/helloworld?api_key=abcdefgh&stream=channel%20name;' ``` Or, use curl: ``` - curl -X POST -H "Content-Type: application/json" -d '{ "featured_title":"Marilyn Monroe", "featured_url":"https://en.wikipedia.org/wiki/Marilyn_Monroe" }' http://localhost:9991/api/v1/external/helloworld\?api_key=abcdefgh&stream=stream%20name; + curl -X POST -H "Content-Type: application/json" -d '{ "featured_title":"Marilyn Monroe", "featured_url":"https://en.wikipedia.org/wiki/Marilyn_Monroe" }' http://localhost:9991/api/v1/external/helloworld\?api_key=abcdefgh&stream=channel%20name; ``` {!congrats.md!} diff --git a/zerver/webhooks/homeassistant/doc.md b/zerver/webhooks/homeassistant/doc.md index d823255b3c..c07ee51042 100644 --- a/zerver/webhooks/homeassistant/doc.md +++ b/zerver/webhooks/homeassistant/doc.md @@ -9,7 +9,7 @@ 1. The `api_key` parameter should correspond to your bot's key. The `stream` parameter is not necessarily required; if not given, it will default to - the `homeassistant` stream. + the `homeassistant` channel. 1. And the URL under `resource` should start with: diff --git a/zerver/webhooks/newrelic/doc.md b/zerver/webhooks/newrelic/doc.md index a26d0bf122..f5346ad92e 100644 --- a/zerver/webhooks/newrelic/doc.md +++ b/zerver/webhooks/newrelic/doc.md @@ -1,4 +1,4 @@ -New Relic can send messages to a Zulip stream for incidents. +New Relic can send messages to a Zulip channel for incidents. 1. {!create-channel.md!} diff --git a/zerver/webhooks/opencollective/doc.md b/zerver/webhooks/opencollective/doc.md index 281aa8c67e..8648c14760 100644 --- a/zerver/webhooks/opencollective/doc.md +++ b/zerver/webhooks/opencollective/doc.md @@ -1,4 +1,4 @@ -This integration currently supports getting notifications to a stream of your Zulip instance, +This integration currently supports getting notifications to a channel of your Zulip instance, when a new member signs-up on an **Open Collective** page. 1. {!create-channel.md!} diff --git a/zerver/webhooks/slack/doc.md b/zerver/webhooks/slack/doc.md index 0ccd6af3bf..fb794d7015 100644 --- a/zerver/webhooks/slack/doc.md +++ b/zerver/webhooks/slack/doc.md @@ -10,17 +10,17 @@ See also the [Slack-compatible webhook](/integrations/doc/slack_incoming). 1. {!generate-integration-url.md!} If you'd like to map Slack channels to different topics within the same - stream, add `&channels_map_to_topics=1` to the end of the URL. Note that + channel, add `&channels_map_to_topics=1` to the end of the URL. Note that this should be used instead of specifying a topic in the URL. If a topic is specified in the URL, then it will be prioritized over the channel to topic mapping. - If you'd like to map Slack channels to different streams, add + If you'd like to map Slack channels to different channels, add `&channels_map_to_topics=0` to the end of the URL. Make sure you create - streams for all your public Slack channels *(see step 1)*, and that the - name of each stream is the same as the name of the Slack channel it maps - to. Note that in this case, the channel to stream mapping will be - prioritized over the stream specified in the URL. + channels for all your public Slack channels *(see step 1)*, and that the + name of each channel is the same as the name of the Slack channel it maps + to. Note that in this case, the channel to channel mapping will be + prioritized over the channel specified in the URL. 1. Go to and click **Add Outgoing WebHooks integration**. diff --git a/zerver/webhooks/splunk/doc.md b/zerver/webhooks/splunk/doc.md index cfa9b62bc4..c3103de7b7 100644 --- a/zerver/webhooks/splunk/doc.md +++ b/zerver/webhooks/splunk/doc.md @@ -21,8 +21,8 @@ See your Splunk Search alerts in Zulip! !!! tip "" You can create as many search alerts as you like, with whatever - stream and topic you choose. Just update your webhook URL as - appropriate for each one, and make sure the stream exists. + channel and topic you choose. Just update your webhook URL as + appropriate for each one, and make sure the channel exists. {!congrats.md!} diff --git a/zerver/webhooks/zendesk/doc.md b/zerver/webhooks/zendesk/doc.md index 3a82a2be27..e97142dad8 100644 --- a/zerver/webhooks/zendesk/doc.md +++ b/zerver/webhooks/zendesk/doc.md @@ -27,7 +27,7 @@ ![](/static/images/integrations/zendesk/003.png) 1. Now, select **Test Target** and click **Submit**. A test message should - appear in the `zendesk` stream. If the message was received, save the + appear in the `zendesk` channel. If the message was received, save the target by selecting **Create target** and clicking **Submit**. 1. From here, add a new trigger. You'll do this for every action you want