Product
OVERVIEW
FEATURES
USE CASES
Case Studies
BUSINESS EDUCATION and RESEARCH OPEN SOURCE and COMMUNITIES
Resources
FOR USERS FOR ADMINISTRATORS
Pricing
Download
New organization
Log in
Sign up

Miscellaneous

Hello World

Miscellaneous

Back to list

Zulip Hello World integration

Learn how Zulip integrations work with this simple Hello World example!

This webhook is Zulip's official example integration.

  • Instructions for all platforms

  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.

  2. Create a bot for Hello World. Make sure that you select Incoming webhook as the Bot type.

  3. Decide where to send Hello World notifications, and generate the integration URL.

  4. To trigger a notification using this example webhook, you can use send_webhook_fixture_message from a Zulip development environment:

    (zulip-server) 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;

You're done! Your Hello World notifications may look like this:

Logos are trademarks of their respective owners. None of the integrations on this page are created by, affiliated with, or supported by the companies represented by the logos.