Zulip Connector

Connect Zenmako to Zulip to manage team communication. This enables AI to post messages to channels and topics, search conversations, send direct messages, and manage channel subscriptions.

Getting Your Credentials

Zulip requires your email, API key, and realm URL for authentication.

Step 1: Find Your Realm URL

Step 2: Get Your API Key

  • Log into your Zulip organization
  • Click on the gear icon in the upper right corner
  • Select Personal settings
  • Navigate to Account & privacy
  • Scroll to the API key section
  • Click Manage your API key
  • Enter your password and click Get API key
  • Copy the API key displayed

    • Your API key is tied to your Zulip account. Keep it secure and do not share it publicly.

    Connecting Zulip

  • Navigate to the Connections page in Zenmako
  • Click Add Connection and select Zulip
  • Enter your credentials:
    • - Email: Your Zulip email address (e.g., yourname@example.com) - API Key: Paste the API key from your Zulip settings - Realm: Your Zulip organization URL (e.g., https://yourorganization.zulipchat.com)
  • Click Save
  • Click Test Connection to verify the setup works

    • If the test succeeds, your Zulip connection is ready to use.

    Available Actions

    ActionDescription
    getStreamsGet all accessible Zulip channels/streams
    getUsersGet all Zulip users in the organization
    postToChannelTopicPost a message to a specific channel and topic
    getChannelActivityGet recent activity summary for a channel including topics
    searchMessagesInChannelSearch messages using filters (channel, topic, sender, text)
    postReplyWithMentionReply to a message while mentioning a specific user
    subscribeUserToChannelSubscribe a user to a channel, optionally with an introduction message
    sendDirectMessageSend a private/direct message to a user

    Example Prompts

    Try these prompts to interact with your Zulip data:

  • "Show me all channels in Zulip"
  • "Post a message to the #engineering channel under the topic 'standup' saying 'Sprint planning starts at 2pm'"
  • "Search for messages about 'deployment' in the #devops channel"
  • "Send a direct message to alice@example.com asking about the project status"
  • "Subscribe bob@example.com to the #announcements channel"

    • Common Issues

    "User not found" or "Channel not found" error

    Zulip is case-sensitive for channel and user lookups. Solutions:

  • Use the getStreams action to see the exact channel names
  • Use the getUsers action to find the correct user email addresses
  • Ensure the channel or user exists in your Zulip organization

    • Cannot post to a channel

    You can only post to channels you have permission to access. If posting fails:

  • Verify you are subscribed to the channel in Zulip
  • Check if the channel is private and requires explicit subscription
  • Ask a channel administrator to add you if needed