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
c1d0ffe099b97e518ca8c5fbe985e8945fcc6fea
zulip/zerver/webhooks/helloworld/doc.md
Lauryn Menard c1d0ffe099 integrations-docs: Update Hello World for current macros and style. 
Updates the Hello World integration documentation and the section
of the related tutorial on documenting the example integration
for the currently used shared macro `create-bot-construct-url.md`.

Also, updates them to use the numbered style currently used in
the majority of the integrations documentation pages.
2022-11-28 12:21:36 -08:00

1.3 KiB
Raw Blame History

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!}