Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Zulip (BYOK) — connector documentation

  • MCP endpoint: https://byok-zulip.connectorbay.com/mcp
  • REST API: POST https://byok-zulip.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-zulip.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Zulip Zulip account email (of the user or bot), sent in the X-Upstream-Key header and the Zulip API key in X-Upstream-Key-2 of every request (never stored, logged or cached)
  • Health: https://byok-zulip.connectorbay.com/health · Tool schemas: https://byok-zulip.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-zulip · agent@connectorbay.com

What Zulip (BYOK) is for

Zulip (BYOK) lets an AI assistant read your own Zulip data through the Zulip API with a key you supply (Zulip account email (of the user or bot)). Read-only: 11 tools (get_own_user, list_users, get_user, list_channels, get_channel, list_channel_topics, list_channel_subscribers, list_subscriptions, list_user_groups, list_linkifiers, get_server_settings). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to *.zulipchat.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Zulip. Zulip and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which Zulip account is this API key for?"
  • "Who is in my Zulip organization?"
  • "What is the role of Zulip user 5?"
  • "Which channels exist in my Zulip organization?"
  • "Is Zulip channel 12 private?"
  • "What topics are being discussed in Zulip channel 12?"

What it does

  • get_own_user: Show the Zulip user or bot the key belongs to: name, email, role, time zone, join date and active flag.
  • list_users: List the users of the organization (people and bots) with name, email, role, active flag and time zone.
  • get_user: Get one Zulip user by numeric ID: name, email, role, active and bot flags, time zone and join date.
  • list_channels: List the channels (streams) the account can see with description, privacy flags, subscriber count and weekly traffic.
  • get_channel: Get one Zulip channel by numeric ID: name, description, privacy flags, creation time, subscriber count and retention days.
  • list_channel_topics: List the topic names in a channel with the newest message ID of each topic (message text is not returned).
  • list_channel_subscribers: List the user IDs subscribed to a channel (use list_users to look up names).
  • list_subscriptions: List the channels the account is subscribed to with notification settings, mute flag, color and optionally subscriber IDs.
  • list_user_groups: List the user groups of the organization with name, description, member IDs and system-group flag.
  • list_linkifiers: List the organization's linkifiers: patterns such as #123 that Zulip turns into links.
  • get_server_settings: Get the organization's public settings: name, description, Zulip version, feature level and which login methods are on.

BYOK key

You bring your own Zulip Zulip account email (of the user or bot) (https://zulip.com/api/api-keys). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to *.zulipchat.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Zulip API (*.zulipchat.com) with a BYOK key; documentation: https://zulip.com/api/rest. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Zulip. Zulip and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Zulip account.

Built for: Worldwide. Languages: English.