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

27 lines
1.3 KiB
Markdown
Raw Normal View History

/api: Clean up the API documentation homepage.
2018-04-17 00:15:26 +02:00
# The Zulip API
/api/: Add Markdown-based /api-new documentation. This commit allows for the /api-new/ page to rendered similarly to our /help pages. It's based on the old content for /api, but we're not replacing the old content yet, to give a bit of time to restructure things reasonably. Tweaked by eeshangarg and tabbott.
2017-07-25 02:37:04 +02:00
/api: Clean up the API documentation homepage.
2018-04-17 00:15:26 +02:00
Zulip's APIs allow you to integrate other services with Zulip. This
guide should help you find the API you need:
/api/: Add Markdown-based /api-new documentation. This commit allows for the /api-new/ page to rendered similarly to our /help pages. It's based on the old content for /api, but we're not replacing the old content yet, to give a bit of time to restructure things reasonably. Tweaked by eeshangarg and tabbott.
2017-07-25 02:37:04 +02:00
/api: Clean up the API documentation homepage.
2018-04-17 00:15:26 +02:00
* First, check if the tool you'd like to integrate with Zulip
web: Save a needless 301 redirect from /integrations to /integrations/.
2023-03-23 03:47:14 +01:00
[already has a native integration](/integrations/).
/api: Clean up the API documentation homepage.
2018-04-17 00:15:26 +02:00
* Next, check if [Zapier](https://zapier.com/apps) or
api docs: Link to our zapier and ifttt /integrations pages.
2018-08-10 19:11:57 +02:00
[IFTTT](https://ifttt.com/search) has an integration.
[Zulip's Zapier integration](/integrations/doc/zapier) and
[Zulip's IFTTT integration](/integrations/doc/ifttt) often allow
/api: Clean up the API documentation homepage.
2018-04-17 00:15:26 +02:00
integrating a new service with Zulip without writing any code.
* If you'd like to send content into Zulip, you can
api_docs: Split integration-guide.md into separate docs. This commit carves out the overview for incoming webhooks and moves it to its own file. This is a much better way to structure these docs. This is a quick follow-up to Tim Abbott's comment on #9592.
2018-07-04 02:08:27 +02:00
[write a native incoming webhook integration](/api/incoming-webhooks-overview)
api docs: Merge docs for sending stream and private messages.
2018-06-18 17:44:48 +02:00
or use [Zulip's API for sending messages](/api/send-message).
/api: Clean up the API documentation homepage.
2018-04-17 00:15:26 +02:00
* If you're building an interactive bot that reacts to activity inside
Zulip, you'll want to look at Zulip's
[Python framework for interactive bots](/api/running-bots) or
openapi: Make api-docs filename match with operationIds. api docs filenames are basically the operationId of their endpoint in zulip.yaml with `_` replaced by `-`. But some operationIds have changed, so change the affected filenames. Make changes in other files accordingly.
2020-06-11 14:44:00 +02:00
[Zulip's real-time events API](/api/get-events).
api docs: Make the Home page more straightforward. Fixes #9854.
2018-06-30 14:41:50 +02:00
And if you still need to build your own integration with Zulip, check out
the full [REST API](/api/rest), generally starting with
[installing the API client bindings](/api/installation-instructions).
In case you already know how you want to build your integration and you're
just looking for an API key, we've got you covered [here](/api/api-keys).