mirror of https://github.com/zulip/zulip.git
32 lines
1.4 KiB
HTML
32 lines
1.4 KiB
HTML
|
<p>Learn how Zulip integrations work with this simple Hello World example!</p>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
The Hello World webhook will use the <code>test</code> stream, which is
|
||
|
|
created by default in the Zulip dev environment. If you are running
|
||
|
|
Zulip in production, you should make sure this stream exists.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Next, on your {{ settings_html|safe }}, create a Hello World bot. Construct the URL for
|
||
|
|
the Hello World bot using the API key and stream name:
|
||
|
|
<code>{{ external_api_uri_subdomain }}/v1/external/helloworld?api_key=abcdefgh&stream=test</code>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>To trigger a notication using this webhook, use `send_webhook_fixture_message` from the Zulip command line:</p>
|
||
|
|
<div class="codehilite">
|
||
|
|
<pre>(zulip-venv)vagrant@vagrant-ubuntu-trusty-64:/srv/zulip$
|
||
|
|
./manage.py send_webhook_fixture_message \
|
||
|
|
> --fixture=zerver/fixtures/helloworld/helloworld_hello.json \
|
||
|
|
> '--url=http://localhost:9991/api/v1/external/helloworld?api_key=<api_key>'
|
||
|
|
</pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>Or, use curl:</p>
|
||
|
|
<div class="codehilite">
|
||
|
|
<pre>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\=<api_key></pre>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p><b>Congratulations! You're done!</b><br/> Your messages may look like:</p>
|
||
|
|
|
||
|
|
<img class="screenshot" src="/static/images/integrations/helloworld/001.png"/>
|