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

22 lines
1.1 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
[already has a native integration](/integrations).
* Next, check if [Zapier](https://zapier.com/apps) or
[IFTTT](https://ifttt.com/search/services) has an integration;
Zulip's native integrations with Zapier and IFTTT often allow
integrating a new service with Zulip without writing any code.
* If you'd like to send content into Zulip, you can
docs: Rename "webhooks" to "incoming webhooks". I only renamed references that I thought were absolutely necessary and only if the resulting sentence structure wasn't awkward. If the renaming resulted in awkward structure, I replaced the term "webhook" with "integration" (but only in some very obvious cases). Fixes #9500.
2018-05-31 01:56:18 +02:00
[write a native incoming webhook integration](/api/integration-guide#incoming-webhook-integrations)
/api: Clean up the API documentation homepage.
2018-04-17 00:15:26 +02:00
or use [Zulip's API for sending messages](/api/stream-message).
* 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
[Zulip's real-time events API](/api/get-events-from-queue).
* If you'd like to do something else, check out the full
[REST API](/api/rest), generally starting with
[installing the API client bindings](/api/installation-instructions).