Zulip Realm Config (BYOK)

Zulip Realm Config (BYOK) — connector documentation

• MCP endpoint: https://byok-zulip-realm-config.connectorbay.com/mcp
• REST API: POST https://byok-zulip-realm-config.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-zulip-realm-config.connectorbay.com/openapi.json
• Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
• Authentication: your own Zulip Realm Config 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-realm-config.connectorbay.com/health · Tool schemas: https://byok-zulip-realm-config.connectorbay.com/tools.json
• Publisher: Unify Dynamics LLC · connectorbay.com/byok-zulip-realm-config · agent@connectorbay.com

What Zulip Realm Config (BYOK) is for

Zulip Realm Config (BYOK) lets an AI assistant read your own Zulip Realm Config data through the Zulip Realm Config API with a key you supply (Zulip account email (of the user or bot)). Read-only: 8 tools (list_profile_fields, list_allowed_domains, list_channel_folders, list_data_exports, get_user_group_members, get_user_group_subgroups, get_channel_id, list_user_channel_ids). 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 Realm Config. Zulip Realm Config 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 custom profile fields does our Zulip organization define?"
• "Which email domains are allowed to join our Zulip organization?"
• "How are our Zulip channels grouped into folders?"
• "When was our Zulip organization last exported?"
• "Who is in the Zulip user group with ID 12?"
• "Which subgroups does Zulip user group 12 contain?"

What it does

• list_profile_fields: List the organization's custom profile fields with name, hint, type code, display order and whether each is required or editable by users.
• list_allowed_domains: List the email domains that may sign up to the organization, with whether subdomains are allowed.
• list_channel_folders: List channel folders (groupings of channels) with name, description, order, creator, creation time and archived flag.
• list_data_exports: List the organization's data exports with type, time, creator user ID and whether each is pending, failed or deleted. Download links are not returned.
• get_user_group_members: List the user IDs and sub-group IDs that belong to a user group (direct members only if requested).
• get_user_group_subgroups: List the IDs of the subgroups of a user group (direct subgroups only if requested).
• get_channel_id: Look up the numeric ID of a channel from its exact name.
• list_user_channel_ids: List the IDs of the channels a user is subscribed to.

BYOK key

You bring your own Zulip Realm Config 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

• https://zulip.com/api/get-custom-profile-fields (the API this connector calls, with a BYOK key)

Live from the Zulip Realm Config API (*.zulipchat.com) with a BYOK key; documentation: https://zulip.com/api/get-custom-profile-fields. 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 Realm Config. Zulip Realm Config 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 Realm Config account.

Built for: Worldwide. Languages: English.

Zulip Realm Config (BYOK) — Privacy Policy

Effective 24 October 2026. Unify Dynamics LLC ("we", "us"), Menlo Park, California.

What Zulip Realm Config (BYOK) is. Zulip Realm Config (BYOK) is a connector (an MCP server and REST API) that an AI assistant calls on your behalf to read your own Zulip Realm Config data: Read your Zulip Cloud organization's custom profile fields, allowed email domains, channel folders, data export history and user group membership with your own bot or user API key (no messages). You bring your own Zulip Realm Config Zulip account email (of the user or bot); the assistant sends it to us with each request.

BYOK key. The key you supply is used to make the one Zulip Realm Config call you asked for. Our application does not store it, write it to a log, put it in a cache, or share it. It is sent only to *.zulipchat.com, over https, and is removed from any text we return to you or your assistant. We do not follow redirects with your key. If Zulip Realm Config rejects it, we say so without repeating it.

What we receive. The arguments of each tool call, the BYOK key (for that call only), the technical headers needed to serve the request (an IP address or a client identifier supplied by the assistant) and standard server logs. What Zulip Realm Config receives. The request we make on your behalf, including the key and the arguments, under Zulip Realm Config's own terms and privacy policy. Zulip Realm Config acts at your direction and is the only recipient of the data of your request besides our hosting provider.

What we return. The answer Zulip Realm Config gives for your request, trimmed to the fields the tool documents. We do not keep it: it is returned to your assistant and not stored, cached or used to train anything.

What we do not do. We do not build a profile, sell or share personal information, or keep your Zulip Realm Config data. Rate-limit counters (a client identifier and timestamps) are held in memory for at most 24 hours. Hosting access logs (IP addresses, request paths and status codes) are kept for up to 30 days for security and abuse prevention; our application adds no request headers or bodies to them.

Sub-processors. Zulip Realm Config (the API you call with a BYOK key, at your direction). Hosting: Vercel (United States regions).

Your rights. Because we store no personal data beyond short-lived logs, requests to access, correct or delete data are usually satisfied automatically; you can still contact agent@connectorbay.com and we will respond within 30 days. Revoke your key at Zulip Realm Config at any time to end all access.

Children. Zulip Realm Config (BYOK) is a general-audience service operated by the adult using the assistant, under Zulip Realm Config's own age rules.

Changes. We will post changes here with a new effective date.

Zulip Realm Config (BYOK) — Terms of Service

Effective 24 October 2026. These terms govern use of the Zulip Realm Config (BYOK) connector ("the Service") operated by Unify Dynamics LLC ("we", "us").

1. The Service. Zulip Realm Config (BYOK) provides: Read your Zulip Cloud organization's custom profile fields, allowed email domains, channel folders, data export history and user group membership with your own bot or user API key (no messages). It is accessed through an AI assistant or directly over MCP or HTTP, and is read-only.
2. Your own key, your own account. You must use your own Zulip Realm Config credentials and only access data you are allowed to access. Zulip Realm Config's terms apply to your use of Zulip Realm Config; you are responsible for complying with them, including any rate limits and permitted uses. Do not share a key you do not own.
3. Independent. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Zulip Realm Config. Zulip Realm Config and its logos are trademarks of their owners and are used only to say which service the connector works with.
4. No advice, no guarantees. Output is the data Zulip Realm Config returns, lightly trimmed; it may be incomplete, delayed or changed by Zulip Realm Config. Check important facts at the source.
5. Read-only. The Service does not create, change, send or delete anything in your Zulip Realm Config account.
6. Acceptable use. Automated use within the published rate limits is welcome. Do not use the Service to access data you are not entitled to, to circumvent Zulip Realm Config's controls, or to attack any system.
7. Availability. The Service is provided "as is" without warranty. We may change, limit or discontinue it at any time; Zulip Realm Config may change or end its API at any time.
8. Data. Our Privacy Policy describes what we process. In short: the BYOK key is used for the one call and not stored or logged.
9. Pro keys. Optional ConnectorBay Pro API keys are issued at our discretion and are separate from your Zulip Realm Config key.
10. Liability. To the fullest extent permitted by law, Unify Dynamics LLC is not liable for any loss arising from use of or reliance on the Service, including any action Zulip Realm Config takes on your account. Our total liability is limited to US $100.
11. Governing law. California law; venue in San Mateo County, California.
12. Contact. Unify Dynamics LLC · agent@connectorbay.com · https://connectorbay.com/byok-zulip-realm-config

Zulip Realm Config (BYOK) support

Email agent@connectorbay.com. We answer within two business days.

• MCP endpoint: https://byok-zulip-realm-config.connectorbay.com/mcp
• REST API: https://byok-zulip-realm-config.connectorbay.com/openapi.json
• Live status: https://byok-zulip-realm-config.connectorbay.com/health

When you report a problem, include the question you asked your agent, roughly when, and which agent you used (for example Claude, ChatGPT or Gemini). Never send us passwords, account numbers or ID numbers. Zulip Realm Config (BYOK) never asks for them.