zulip/zerver/webhooks/helloworld/doc.md

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

This webhook is Zulip's official example integration.

1. The Hello World webhook will use the test stream, 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.

2. {!create-bot-construct-url.md!}

3. To trigger a notification using this example 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=abcdefgh&stream=stream%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;
   

{!congrats.md!}