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

integration-docs: Update Hello World for new doc format. 

Part of #29592.
This commit is contained in:
adnan-td 2024-07-04 17:09:02 +05:30 committed by Tim Abbott
parent 6846d2a520
commit a35c9795fa
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
zerver/webhooks/helloworld/doc.md
View File

@ -1,15 +1,19 @@
# Zulip Hello World integration
Learn how Zulip integrations work with this simple Hello World example! Learn how Zulip integrations work with this simple Hello World example!
This webhook is Zulip's official [example This webhook is Zulip's official [example
integration](/api/incoming-webhooks-walkthrough). integration](/api/incoming-webhooks-walkthrough).
{start_tabs}
1. The Hello World webhook will use the `test` channel, which is created 1. The Hello World webhook will use the `test` channel, which is created
by default in the Zulip development environment. If you are running by default in the Zulip development environment. If you are running
Zulip in production, you should make sure that this channel exists. Zulip in production, you should make sure that this channel exists.
1. {!create-an-incoming-webhook.md!} 1. {!create-an-incoming-webhook.md!}
1. {!generate-integration-url.md!} 1. {!generate-webhook-url-basic.md!}
1. To trigger a notification using this example webhook, you can use 1. To trigger a notification using this example webhook, you can use
`send_webhook_fixture_message` from a [Zulip development `send_webhook_fixture_message` from a [Zulip development
@ -28,6 +32,12 @@ integration](/api/incoming-webhooks-walkthrough).
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; 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;
``` ```
{end_tabs}
{!congrats.md!} {!congrats.md!}
![](/static/images/integrations/helloworld/001.png) ![](/static/images/integrations/helloworld/001.png)
### Related documentation
{!webhooks-url-specification.md!}