mirror of
https://github.com/zulip/zulip.git
synced 2025-11-09 08:26:11 +00:00
87007df8eb
Note: This doesn't change the occurences in the Zapier integration doc, since they refer to pieces of the UI in Zapier, which may still be using the "Stream" terminology.
34 lines
1.3 KiB
Markdown
34 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` channel, which is created
|
|
by default in the Zulip development environment. If you are running
|
|
Zulip in production, you should make sure that this channel exists.
|
|
|
|
1. {!create-an-incoming-webhook.md!}
|
|
|
|
1. {!generate-integration-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=channel%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=channel%20name;
|
|
```
|
|
|
|
{!congrats.md!}
|
|
|
|
|