zulip/zerver/webhooks/helloworld/doc.md at fd0b013bcdcd5d40cbfde1d204a33e1a0b2bc4f9

mirror of https://github.com/zulip/zulip.git synced 2025-11-05 06:23:38 +00:00

Files

Anders Kaseorg a543dcc8e3 Remove Debian 10 support.

As a consequence:

• Bump minimum supported Python version to 3.8.
• Move Vagrant environment to Ubuntu 20.04, which has Python 3.8.
• Move CI frontend tests to Ubuntu 20.04.
• Move production build test to Ubuntu 20.04.
• Move 3.4 upgrade test to Ubuntu 20.04.

Signed-off-by: Anders Kaseorg <anders@zulip.com>

2022-04-26 16:32:02 -07:00

1.4 KiB

Raw Blame History

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

This webhook is Zulip's official example integration.

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.
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

To trigger a notification using this webhook, you can use send_webhook_fixture_message from a Zulip development environment:

(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=&lt;api_key&gt;'

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\=&lt;api_key&gt;

{!congrats.md!}

1.4 KiB Raw Blame History

1.4 KiB

Raw Blame History