Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/zerver/webhooks/helloworld/doc.md

35 lines
1.1 KiB
Markdown
Raw Normal View History

webhooks/helloworld: Migrate docs to Markdown.
2017-06-02 03:58:33 +02:00
Learn how Zulip integrations work with this simple Hello World example!
The Hello World webhook will use the `test` stream, which is
created by default in the Zulip dev environment. If you are running
Zulip in production, you should make sure that this stream exists.
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:
template context: Give better names to the URLs for the API. The "subdomain" label is redundant, to the extent it's even accurate -- this is really just the URL we want to display, which may or may not involve a subdomain. Similarly "external". The former `external_api_path_subdomain` was never a path -- it's a host, followed by a path, which together form a scheme-relative URL. I'm not quite convinced that value is actually the right thing in 2 of the 3 places we use it, but fixing that can start by giving an accurate name to the thing we have.
2017-10-30 22:04:15 +01:00
`{{ api_url }}/v1/external/helloworld?api_key=abcdefgh&stream=test`
webhooks/helloworld: Migrate docs to Markdown.
2017-06-02 03:58:33 +02:00
To trigger a notification using this webhook, use
`send_webhook_fixture_message` from the Zulip command line:
```
create-production-venv: Remove Python 2 support. We still create a Python 2 virtualenv for thumbor but that’s separate (/srv/zulip-thumbor-venv from scripts/lib/create-thumbor-venv). Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2019-01-10 01:30:44 +01:00
(zulip-py3-venv)vagrant@vagrant-ubuntu-trusty-64:/srv/zulip$
webhooks/helloworld: Migrate docs to Markdown.
2017-06-02 03:58:33 +02:00
./manage.py send_webhook_fixture_message \
tests: Move zerver/fixtures to zerver/tests/fixtures for clarity. Fixes #9153.
2018-04-19 20:17:24 +02:00
> --fixture=zerver/tests/fixtures/helloworld/hello.json \
webhooks/helloworld: Migrate docs to Markdown.
2017-06-02 03:58:33 +02:00
> '--url=http://localhost:9991/api/v1/external/helloworld?api_key=&lt;api_key&gt;'
```
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\=&lt;api_key&gt;
```
{!congrats.md!}
![](/static/images/integrations/helloworld/001.png)