Some checks failed
Code scanning / CodeQL (push) Failing after 15s
Zulip production suite / Ubuntu 22.04 production build (push) Failing after 26s
Zulip production suite / Debian 12 production install with custom db name and user (push) Has been skipped
Zulip production suite / Ubuntu 22.04 production install and PostgreSQL upgrade with pgroonga (push) Has been skipped
Zulip production suite / Ubuntu 24.04 production install (push) Has been skipped
Zulip production suite / Ubuntu 26.04 production install (push) Has been skipped
Zulip production suite / Debian 13 production install (push) Has been skipped
Zulip production suite / 7.0 Version Upgrade (push) Has been skipped
Zulip production suite / 8.0 Version Upgrade (push) Has been skipped
Zulip production suite / 6.0 Version Upgrade (push) Has been skipped
Zulip production suite / 10.0 Version Upgrade (push) Has been skipped
Zulip production suite / 9.0 Version Upgrade (push) Has been skipped
Zulip production suite / 12.0 Version Upgrade (push) Has been skipped
Zulip production suite / 11.0 Version Upgrade (push) Has been skipped
GitHub Actions Security Analysis with zizmor / zizmor (push) Failing after 3s
Zulip CI / Debian 12 (Python 3.11, backend + documentation) (push) Failing after 26s
Zulip CI / Ubuntu 22.04 (Python 3.10, backend + frontend) (push) Failing after 3s
Zulip CI / Ubuntu 24.04 (Python 3.12, backend) (push) Failing after 25s
Zulip CI / Ubuntu 26.04 (Python 3.14, backend) (push) Failing after 25s
Zulip CI / Debian 13 (Python 3.13, backend) (push) Failing after 28s
Zulip production suite / Required jobs (push) Has been cancelled
Zulip CI / Required jobs (push) Has been cancelled
API Documentation Update Check / check-feature-level-updated (push) Has been cancelled
API Documentation Update Check / notify-if-api-docs-changed (push) Has been cancelled
29 lines
1.4 KiB
Markdown
29 lines
1.4 KiB
Markdown
# The Zulip API
|
|
|
|
Zulip's APIs allow you to integrate other services with Zulip. This
|
|
guide should help you find the API you need:
|
|
|
|
* 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) has an integration.
|
|
[Zulip's Zapier integration](/integrations/zapier) and
|
|
[Zulip's IFTTT integration](/integrations/ifttt) often allow
|
|
integrating a new service with Zulip without writing any code.
|
|
* If you'd like to send content into Zulip, you can
|
|
[write a native incoming webhook integration][incoming-webhooks-overview]
|
|
or use [Zulip's API for sending messages](/api/send-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](/help/running-bots) or
|
|
[Zulip's real-time events API](/api/get-events).
|
|
|
|
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).
|
|
|
|
[incoming-webhooks-overview]: https://zulip.readthedocs.io/en/latest/webhooks/incoming-webhooks-overview.html
|