mirror of
https://github.com/zulip/zulip.git
synced 2025-11-06 15:03:34 +00:00
c1d0ffe099
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.
32 lines
1.3 KiB
Markdown
32 lines
1.3 KiB
Markdown
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 created
|
|
by default in the Zulip development environment. If you are running
|
|
Zulip in production, you should make sure that this stream exists.
|
|
|
|
1. {!create-bot-construct-url.md!}
|
|
|
|
1. To trigger a notification using this example 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@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!}
|
|
|
|
|