paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-23 04:52:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

integrations: Make Hello World example less confusing.

Browse Source
This commit is contained in:
Tim Abbott
2021-03-25 01:40:29 -07:00
parent b9549250f3
commit c3998a3d3b
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
zerver/webhooks/helloworld/doc.md
View File

@@ -1,5 +1,8 @@
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
by default in the Zulip dev environment. If you are running
Zulip in production, you should make sure that this stream exists.
@@ -10,8 +13,9 @@ Learn how Zulip integrations work with this simple Hello World example!
`{{ api_url }}/v1/external/helloworld?api_key=abcdefgh&stream=test`
1. To trigger a notification using this webhook, use
`send_webhook_fixture_message` from the Zulip command line:
1. To trigger a notification using this webhook, you can use
`send_webhook_fixture_message` from a [Zulip development
environment](https://zulip.readthedocs.io/en/latest/development/overview.html):
(zulip-py3-venv) vagrant@ubuntu-bionic:/srv/zulip$
./manage.py send_webhook_fixture_message \