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
Files
b9549250f37548443dd95c6ebade1e90bf704f1e
zulip/zerver/webhooks/helloworld/doc.md
Adam Birds b9549250f3 integrations: Update Hello World Docs. 
I have the updated the documentation page for the hello world
integration to include numbers to bring it up to standard and make it
more readable.

Fixes part of #17633.
2021-03-25 01:36:05 -07:00

1.2 KiB
Raw Blame History

Learn how Zulip integrations work with this simple Hello World example!

  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.

  2. Next, on your {{ settings_html|safe }}, create a Hello World bot. the URL for the Hello World bot using the API key and stream name:

    {{ api_url }}/v1/external/helloworld?api_key=abcdefgh&stream=test

  3. To trigger a notification using this webhook, use send_webhook_fixture_message from the Zulip command line:

    (zulip-py3-venv) vagrant@ubuntu-bionic:/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=<api_key>'

    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\=<api_key>

{!congrats.md!}