Zulip
Team chat platform for streams, topics, messages, users, reactions, and organization conversations.
Covers topic-based team chat around streams, messages, users, reactions, and organization conversation data.
Example Use Cases
These are the Zulip actions Snow can use when building apps with you. Connecting an account does not make Snow run these on its own.
Tool to create a new channel in Zulip. Use when you need to set up a new communication channel with specified subscribers. Channels organize conversations by topic within Zulip.
Tool to create a scheduled message in Zulip. Use when you need to schedule a message to be sent at a future time to channels or direct messages.
Tool to delete a reminder from Zulip. Use when you need to remove a scheduled reminder by its ID.
Tool to delete a saved snippet by its ID. Use when you need to remove a snippet from saved snippets.
Tool to delete a scheduled message in Zulip. Use when you need to cancel a message that was scheduled to be sent later. This is permanent and cannot be undone.
Tool to retrieve all channels (streams) in Zulip that match specified filters. Use when you need to list available channels, discover public channels, or find channels the user has access to. Returns detailed metadata for each channel including permissions and settings.
Tool to get detailed information about a Zulip channel by its ID. Use when you need to retrieve complete channel details including permissions, settings, and metadata.
Tool to get a channel's unique ID by its name. Use when you need to retrieve the numeric identifier for a channel given its human-readable name.
Tool to fetch a single message by ID from Zulip. Use when you need to retrieve the full details of a specific message including its content, sender, reactions, and edit history.
Tool to fetch messages from Zulip. Use when you need to retrieve messages using various filters like anchor position, narrow queries, or specific message IDs. Supports pagination via num_before/num_after parameters.
Tool to retrieve the profile information for the authenticated user. Use when you need to get details about the current user such as email, full name, role, timezone, or other profile data.
Tool to fetch all scheduled messages for the authenticated user. Use when you need to retrieve all undelivered scheduled messages, which are returned in order of scheduled delivery time (earliest first).
Tool to retrieve all topics in a Zulip channel. Use when you need to get the list of discussion topics within a specific channel, along with the maximum message ID for each topic.
Tool to retrieve all channels (streams) the authenticated user is subscribed to. Use when you need to list subscribed channels with their details including names, IDs, and optionally subscriber lists.
Tool to fetch a user by email address from Zulip. Use when you need to retrieve detailed information about a specific user including their profile, role, and status.
Tool to mark all messages as read for the authenticated user. Use when you need to clear all unread message indicators. Note: This endpoint is deprecated.
Tool to mark all messages in a Zulip channel as read. Use when you need to mark all unread messages in a specific channel as read.
Tool to mark all messages in a topic as read. Use when you need to clear unread status for all messages within a specific topic in a channel.
Tool to send a message in Zulip. Use when you need to send a direct message to users or post a message to a channel/stream.
Tool to subscribe users to one or more Zulip channels. Use when you need to add users to channels. If a channel doesn't exist, it will be created automatically. By default, subscribes the authenticated user.
Tool to edit a message in Zulip. Use when you need to update message content, move messages to a different topic or channel, or resolve topics.
Tool to update channel subscriptions by subscribing to new channels or unsubscribing from existing ones. Use when you need to add the user to channels (with optional channel creation) or remove them from channels.
Tool to add alert words to the current user's configuration. Use when you need to configure words that trigger notifications for the user. Alert words are case insensitive and duplicates are automatically ignored.
Tool to add an APNs (Apple Push Notification service) device token to Zulip. Use when registering an iOS device for push notifications.
Tool to add a channel as a default stream in Zulip. Use when you want to configure a channel to be automatically subscribed for all new users joining the organization.
Tool to add a linkifier to a Zulip realm. Use when you need to automatically convert text patterns (like issue numbers or ticket IDs) into clickable links in messages.
Tool to add a navigation view in Zulip. Use when you need to create a custom navigation view or configure a built-in view for display in the sidebar.
Tool to add an emoji reaction to a Zulip message. Use when you want to react to a message with an emoji.
Tool to archive a channel in Zulip. Use when you need to permanently archive a channel by its ID.
Tool to check if specific messages match a narrow filter. Use when you need to determine whether messages satisfy complex search criteria that the client cannot evaluate locally.
Tool to create a BigBlueButton video call in Zulip. Use when you need to generate a video conference link for team meetings or discussions.
Tool to create a new channel folder in Zulip. Use when you need to organize channels into folders for better management.
Tool to create a custom profile field in Zulip. Use when you need to add custom user profile fields for organization members.
Tool to create one or more draft messages in Zulip. Use when you need to save message drafts for later editing or sending.
Tool to create a message reminder in Zulip. Use when you need to set up a reminder for a specific message that will be sent at a scheduled time via the Notification Bot.
Tool to create a reusable invitation link for the Zulip organization. Use when you need to generate an invite link that can be shared with multiple users to join the organization.
Tool to create a saved snippet in Zulip. Use when you need to save reusable text content that can be quickly inserted into messages.
Tool to delete a draft in Zulip. Use when you need to remove a saved draft message.
Tool to delete an event queue previously registered via POST /api/v1/register. Use when you need to clean up a queue that is no longer needed.
Tool to delete a message in Zulip. Use when you need to remove a message from a stream or direct message conversation.
Tool to delete a topic from a Zulip channel/stream. Use when you need to permanently remove a topic and all its messages from a specific stream. Note: This operation is irreversible and will delete all messages in the topic.
Tool to edit an existing draft message in Zulip. Use when you need to update the content, topic, recipients, or other properties of a saved draft.
Tool to update a navigation view in Zulip. Use when you need to pin/unpin a view or rename a custom navigation view.
Tool to edit a saved snippet by updating its title and/or content. Use when you need to modify an existing snippet.
Tool to create a Zulip realm data export. Use when you need to export organization data. The export is created asynchronously and can be downloaded later.
Tool to retrieve all configured alert words for the authenticated user. Use when you need to check which words or phrases trigger notifications.
Tool to retrieve all data exports for the Zulip organization. Use when you need to list all data exports, including their status (pending, completed, or failed) and download URLs. Requires organization administrator access.
Tool to retrieve all unexpired invitations for the Zulip organization. Use when you need to list all active email invitations and reusable invitation links that can be managed by the user.
Tool to get the presence status for a specific user in Zulip. Use when you need to check if a user is currently active, idle, or offline. This endpoint is designed for embedding presence data in external applications. If the timestamp is more than a few minutes old, the user should be considered offline.
Tool to retrieve metadata on files uploaded by the requesting user. Use when you need to list all attachments with their details including file names, sizes, and associated messages.
Tool to retrieve the email address for a Zulip channel. Use when you need to get the email address that can be used to send messages to a specific channel via email.
Tool to retrieve all channel folders in the organization, sorted by display order. Use when you need to list or organize channel folders.
Tool to get all subscribers of a Zulip channel. Use when you need to retrieve the list of user IDs subscribed to a specific channel.
Tool to retrieve all custom emoji configured in the Zulip realm. Use when you need to get the list of available custom emoji including their names, IDs, and source URLs.
Tool to get all custom profile fields configured for the Zulip realm. Use when you need to retrieve the list of custom profile fields including their types, names, and configuration.
Tool to fetch all drafts for the authenticated user. Use when you need to retrieve all saved draft messages, which are returned in order of last edit time (most recent first).
Tool to get events from a Zulip event queue. Use when you need to retrieve new events after registering a queue.
Tool to get a public temporary URL for an uploaded file in Zulip. Use when you need to access or share a file that was previously uploaded to the Zulip organization.
Tool to retrieve all configured linkifiers in the Zulip realm. Use when you need to get the list of regex patterns that are automatically converted to links in messages and topics.
Tool to fetch the complete edit history of a Zulip message. Use when you need to see all changes made to a message over time, including content edits, topic changes, and channel moves. Returns snapshots in chronological order from oldest to newest.
Tool to fetch all navigation views for the authenticated user. Use when you need to retrieve all configured custom navigation views, which are displayed in the sidebar or 'More Views' menu.
Tool to retrieve read receipts for a message in Zulip. Use when you need to see which users have read a specific message.
Tool to retrieve data export consent state for users in a realm. Use when you need to check which users have consented for their private data to be exported by organization administrators.
Tool to retrieve the URL of the Zulip realm's icon. Use when you need to get the organization's icon image URL.
Tool to get the presence status for all users in the Zulip realm. Use when you need to check which users are currently active, idle, or offline across the entire organization. If a user's timestamp is more than a few minutes old, they should be considered offline.
Tool to fetch all undelivered reminders for the authenticated user. Use when you need to retrieve scheduled reminders, which are returned in order of scheduled delivery time. This feature is available in Zulip 11.0+ (feature level 399).
Tool to fetch all saved snippets for the authenticated user. Use when you need to retrieve reusable text content that can be quickly inserted into messages.
Tool to retrieve server configuration and available authentication methods. Use when you need to discover server capabilities, version information, or available login options before authentication.
Tool to check whether a specific user is subscribed to a particular channel (stream). Use when you need to verify subscription status of a user for a given channel.
Tool to retrieve the list of channel IDs that a specific user is subscribed to. Use when you need to get a user's subscribed channels.
Tool to retrieve all members of a specific user group. Use when you need to get the list of user IDs who are members of a user group.
Tool to check if a user is a member of a specific user group. Use when you need to verify user group membership status.
Tool to retrieve subgroups of a user group. Use when you need to get the list of subgroup IDs for a specific user group.
Tool to retrieve all user groups in the Zulip organization. Use when you need to list user groups with their members, subgroups, and permission settings.
Tool to retrieve the status currently set by a user in the Zulip organization. Use when you need to get a user's custom status message, emoji, or away status. Available in Zulip 9.0+ (feature level 262).
Tool to mute or unmute a topic in a Zulip channel. Use when you want to control topic notifications by muting or unmuting specific topics.
Tool to reactivate a deactivated user in Zulip. Use when you need to restore access for a previously deactivated user account.
Tool to register an event queue for receiving Zulip events. Use when you need to set up an event queue to receive real-time updates about messages, subscriptions, and other realm events.
Tool to register an E2EE (end-to-end encrypted) push device for mobile notifications. Use when setting up push notifications with encrypted payloads for mobile clients.
Tool to remove alert words from the current user's configuration. Use when you need to delete words that trigger notifications for the user. Words not in the user's set are automatically ignored.
Tool to delete an attachment in Zulip. Use when you need to remove a file attachment that was previously uploaded.
Tool to remove a code playground from a Zulip realm. Use when you need to delete an existing code playground configuration.
Tool to remove a channel from default streams in Zulip. Use when you want to stop a channel from being automatically subscribed to all new users joining the organization.
Tool to remove an FCM registration token for Android push notifications. Use when unregistering a device from push notifications in Zulip. Note: This endpoint is deprecated.
Tool to remove a linkifier from a Zulip realm. Use when you need to delete an existing linkifier that automatically converts text patterns into clickable links.
Tool to remove a navigation view in Zulip. Use when you need to delete a custom navigation view from the sidebar.
Tool to remove an emoji reaction from a Zulip message. Use when you want to remove a previously added reaction from a message.
Tool to render a message to HTML in Zulip. Use when you need to preview how a message will appear when rendered from Markdown to HTML format.
Tool to reorder channel folders in Zulip. Use when you need to change the display order of channel folders. The order list must include all organization channel folder IDs.
Tool to reorder custom profile fields in Zulip. Use when you need to change the display order of custom profile fields in user profiles and settings. The order list must include all custom profile field IDs.
Tool to reorder linkifiers in Zulip. Use when you need to change the processing order of linkifiers in a realm. The order matters when patterns overlap.
Tool to revoke an email invitation in Zulip. Use when you need to cancel a pending invitation that has not yet been accepted.
Tool to revoke a reusable invitation link for the Zulip organization. Use when you need to invalidate an invite link that was previously created.
Tool to send a test notification to mobile device(s). Use when testing push notifications for mobile clients. Note: This endpoint is deprecated.
Tool to set typing status in Zulip. Use when you want to indicate that a user is typing or has stopped typing a message.
Tool to set typing status when editing a message in Zulip. Use when you want to indicate that a user is editing or has stopped editing a specific message.
Tool to test welcome bot custom message in Zulip. Use when you need to preview how a custom welcome message will appear before setting it as the default for new users.
Tool to unsubscribe from one or more channels (streams) in Zulip. Use when you need to remove users from channels or unsubscribe the authenticated user from channels.
Tool to update a channel in Zulip. Use when you need to modify channel properties such as name, description, permissions, or settings. All parameters are optional - provide only the fields you want to update.
Tool to update a channel folder in Zulip. Use when you need to modify the name, description, or archive status of an existing channel folder.
Tool to update a linkifier in a Zulip realm. Use when you need to modify the pattern or URL template of an existing linkifier that automatically converts text patterns into clickable links.
Tool to update personal message flags in Zulip. Use when you need to mark messages as read/unread, starred/unstarred, or modify other personal message flags. This allows bulk operations on multiple messages at once.
Tool to update personal message flags (e.g., read, starred) for messages matching a narrow filter. Use when you need to mark messages as read/unread or starred/unstarred within a specific conversation, channel, or search criteria.
Tool to update realm-level defaults of user settings in Zulip. Use when you need to configure organization-wide default settings for new users. At least one setting parameter must be provided.
Tool to edit a scheduled message in Zulip. Use when you need to modify the content, delivery time, or target audience of a message scheduled to be sent later.
Tool to update user settings in Zulip. Use when you need to modify user preferences including display settings, notification preferences, privacy settings, and web/desktop app behavior. Can update multiple settings in a single request.
Tool to update your status in Zulip. Use when you need to set or clear your custom status message, emoji, or away status.
Tool to update the status for a specific user in the Zulip organization. Use when you need to set or clear a user's custom status message and emoji.
Tool to update the user's personal settings for channels they are subscribed to. Use when you need to modify channel properties like muting, color, pinning, or per-channel notification settings.
Tool to update a user by email address in Zulip. Use when you need to modify user properties such as full name, email, role, or custom profile fields.
Tool to update personal preferences for a topic in a Zulip channel. Use when you want to control topic visibility by muting, unmuting, or following specific topics.