zulip/api_docs/integrations-overview.md

Integrations overview

Integrations allow you to send data from other products into or out of Zulip. Zulip natively integrates with dozens of products, and with hundreds more through Zapier and IFTTT.

Zulip also makes it very easy to write your own integration, and (if you'd like) to get it merged into the main Zulip repository.

Integrations are one of the most important parts of a group chat tool like Zulip, and we are committed to making integrating with Zulip as easy as possible.

Set up an existing integration

Most existing integrations send content from a third-party product into Zulip.

• Search Zulip's list of native integrations for the third-party product. Each integration has a page describing how to set it up.

• Check if Zapier has an integration with the product. If it does, follow these instructions to set it up.

• Check if IFTTT has an integration with the product. If it does, follow these instructions to set it up.

• Use a third-party webhook integration designed to work with Slack's webhook API pointed at Zulip's Slack-compatible webhook API.

• If the product can send email notifications, you can send those emails to a stream.

Write your own integration

We've put a lot of effort into making this as easy as possible, but all of the options below do require some comfort writing code. If you need an integration and don't have an engineer on staff, contact us and we'll see what we can do.

Sending content into Zulip

• If the third-party service supports outgoing webhooks, you likely want to build an incoming webhook integration.

• If it doesn't, you may want to write a script or plugin integration.

• Finally, you can send messages using Zulip's API.

Sending and receiving content

• To react to activity inside Zulip, look at Zulip's Python framework for interactive bots or Zulip's real-time events API.

• If what you want isn't covered by the above, check out the full REST API. The web, mobile, desktop, and terminal apps are built on top of this API, so it can do anything a human user can do. Most but not all of the endpoints are documented on this site; if you need something that isn't there check out Zulip's REST endpoints or contact us and we'll help you out.