Mattering Automations Zulip integration
Connect Zulip to Mattering Automations: channels and topics, messages, drafts, scheduled messages, users, groups and invitations as workflow steps, authenticated with a three field credential where the site travels with the key and the Basic username is an email address.
The Mattering Automations Zulip integration puts Zulip's REST API on your automation canvas: read and post messages, thread them into topics, schedule sends and set reminders, create and archive channels, manage subscriptions, users, user groups and invitations, upload files, and read the organization settings behind all of it. 113 nodes in total, 40 that read and 73 that act, generated from the machine readable OpenAPI description Zulip publishes in its own source tree rather than written by hand.
The credential is three fields and that is the first thing to get right. Zulip authenticates with HTTP Basic where the username is the account's email address rather than a username, and the password is the API key. On top of that, every Zulip organization is its own realm on its own hostname, whether that is a Zulip Cloud subdomain or a self hosted server, and an API key is only valid against the organization that issued it. So the site is part of the credential: you fill in Zulip site, Account email address and API key, and no node in this integration carries a site field.
Two things are worth reading before you build anything. First, sending a message reaches real people immediately and there is no test mode, no sandbox and no idempotency key anywhere on this API, so a retried send posts twice and a deleted message can still have been read. Two safe rehearsals are built for that and are covered below. Second, Zulip is midway through renaming streams to channels, so node names here say channel while configuration fields keep the wire spelling stream_id. That is Zulip's transition rather than an inconsistency in this integration, and it is explained in full below. This guide ends with the complete node reference.
Before you start
- A Zulip organization you can generate an API key in, on Zulip Cloud or self hosted. Zulip's plan comparison lists REST API custom integrations, custom webhooks and admin controls for bots and integrations on the free Cloud plan, so API access is not gated behind a paid tier, and self hosted Zulip is free and open source under Apache 2.0.
- An awareness of two free plan limits, because they change what a workflow can do rather than whether it connects. Zulip documents 10,000 messages of search history on the free Cloud plan against unlimited search history on its paid plans. That is a limit on search rather than on the messages themselves, so a text search narrow on Zulip: Get Messages can reach the end of it on a busy organization while a plain channel read does not. And free plan file storage is documented as 5 GB total for the organization, where the paid plans are counted per user, which matters for any workflow using Zulip: Upload File.
- Your organization's Zulip site address. On Zulip Cloud that is your subdomain, such as acme.zulipchat.com. On a self hosted server it is the full https host. The site must be reachable over https: a plain http site is refused rather than silently upgraded, because HTTP Basic credentials over plain http are readable by anyone on the network path.
- A decision about which account holds the connection, and a bot is usually the right answer. A bot has its own name and avatar, so an automated message reads as coming from an automation instead of impersonating a colleague, and it survives that colleague leaving. Create it under Personal settings > Bots before you start.
- Enough permission on that account for what you intend to automate. Every node acts with the credential account's own Zulip role, and several nodes are administrator only, including Zulip: Create User, Zulip: Deactivate User and most organization settings. Zulip organizations can also set policies that forbid an action for everyone regardless of role, such as who may delete messages. Both show up as a 403 rather than a 401.
- For self hosted organizations, an idea of which Zulip release you are on. Capability is gated by an integer server feature level rather than by anything in the URL, so a server a few releases behind can silently drop newer request parameters while still answering successfully. Zulip: Get Server Settings reads that feature level and needs no credential.
- Somewhere safe to test anything destructive. There is no vendor sandbox. A second free Zulip Cloud organization, or a self hosted server of your own, is the right place to run the write nodes, the deletes and anything that sends.
- A Mattering workspace with access to the Automations app.
Create a Zulip API key
There is one credential to create and three values to collect: the site, the email address of the account the key belongs to, and the key itself. Zulip's HTTP Basic username is an email address, which is the detail people miss, and the site belongs on the credential because a Zulip API key is a row in exactly one organization's database and means nothing anywhere else. Decide whose key it is before you generate anything, because that account's name, avatar and permissions are what every automation will carry.
Connect Zulip to Mattering
Verify it works
Open any automation canvas and check the palette for a Zulip section listing the read and action nodes. Drop Zulip: Get Own User onto the canvas and run a test step. It is the natural probe: it takes no configuration and answers the question that matters before any write, which is which Zulip account your automations act as. Every message this integration sends is attributed to that account, and its role decides which of the administrator only nodes will work at all.
Now run Zulip: List Channels without changing anything. This confirms the credential can see your organization, and it also shows you the picker source: this lister feeds every channel picker in the integration. Private channels the acting account cannot see are simply absent rather than reported as an error, so if a channel you expected is missing, subscribe the bot to it rather than debugging the connection.
If you are on a self hosted server, run Zulip: Get Server Settings once and note the feature level it returns. It needs no credential, so it also works as a plain reachability check on the site value. Everything in this verify path is read only and safe to re-run: none of these three nodes writes anything or notifies anybody.
Node reference
113 nodes, generated from the connector itself so this reference always matches what ships.
Read and query nodes 40
Zulip: Check Messages Match Narrow
zulip_check_messages_match_narrow
Test a set of message ids against a search narrow and get back only those that match, with the matching text highlighted. This is how a workflow answers whether a message that just arrived belongs to a filter, without refetching the whole narrow.
Zulip: Check User Group Membership
zulip_is_user_group_member
Answer whether one person is in one group, counting subgroup membership unless direct_member_only is set. The right node for an approval gate that asks whether the requester belongs to a team.
Zulip: Get Channel
zulip_get_channel
Fetch one channel by its numeric id, including its permission groups, retention policy and subscriber count.
Zulip: Get Channel Email Address
zulip_get_channel_email_address
Get the email address that posts into a channel, so a system that can only send email can still reach Zulip. Treat the result as sensitive: anyone holding that address can post to the channel without a Zulip account. Requires the organization to have the email gateway configured.
Zulip: Get Channel ID By Name
zulip_get_channel_id
Look up a channel's numeric id from its name. Worth a node of its own because names are what a person types and ids are what the rest of the API wants, and a name that no longer exists fails here clearly instead of failing later as a confusing error on a send.
Zulip: Get Channel Subscribers
zulip_get_channel_subscribers
List the user ids of everyone subscribed to a channel. Ids only, with no names attached, so pair it with List Users when you need people rather than numbers.
Zulip: Get File Temporary URL
zulip_get_file_temporary_url
Turn an uploaded file's path into a short lived unauthenticated download URL, so a downstream worker can fetch the bytes without holding a Zulip credential. The URL grants access to the file to anyone who has it, so treat it as sensitive and do not store it. The path parameters come from splitting a user_uploads path: the first segment is the numeric realm id and the rest is the filename part, which contains literal slashes.
Zulip: Get Message
zulip_get_message
Fetch one message by id, including its raw Markdown source alongside the rendered content. Useful after a trigger hands you a message id and you need the body the author actually typed.
Zulip: Get Message Edit History
zulip_get_message_history
Fetch every edit ever made to a message, oldest first, with the previous content and previous topic recorded on each revision and an HTML diff of what changed. Returns an error when the organization has message edit history disabled.
Zulip: Get Messages
zulip_get_messages
Fetch a slice of message history. Pagination here is ANCHOR based rather than offset or cursor: name an anchor message, ask for a number of messages before and after it, and read found_oldest and found_newest in the response to know whether the history ran out. To walk backwards, anchor on the oldest id you already have and repeat until found_oldest is true. Use narrow to filter by channel, topic, sender or search text.
Zulip: Get Organization Presence
zulip_get_realm_presence
Read presence for everyone in the organization in one call, keyed by email address, with a server timestamp to compare against. People who have turned presence sharing off are absent rather than reported as offline.
Zulip: Get Own User
zulip_get_own_user
Fetch the account the credential belongs to, including its role and its own user id. The cheapest way to confirm a connection is alive and to discover which account an automation is acting as, which matters because every message this connector sends is attributed to this account.
Zulip: Get Read Receipts
zulip_get_read_receipts
List the user ids who have read a message. Read receipts are off by default in most organizations and each person can opt out individually, so an empty list means either nobody has read it or nobody who has is sharing that fact. Never present this count as a delivery guarantee.
Zulip: Get Server Settings
zulip_get_server_settings
Read the server's version, its FEATURE LEVEL and the organization's public identity. This is the diagnostic node for this connector: Zulip gates capability by the integer zulip_feature_level rather than by anything in the URL, so a node that behaves unexpectedly on a self hosted realm is usually running against a server older than the feature it needs. Zulip Cloud tracks the latest release; a self hosted realm is whatever its administrator installed. This endpoint needs no credential, which also makes it a safe first call.
Zulip: Get Subscription Status
zulip_get_subscription_status
Answer whether one person is subscribed to one channel. Cheaper than listing a channel's subscribers when the question is about a single person, and note the path keeps the old spelling at /subscriptions/{stream_id} while the sibling endpoint one level up uses /channels.
Zulip: Get User
zulip_get_user
Fetch one person by their numeric user id.
Zulip: Get User By Email
zulip_get_user_by_email
Fetch one person by email address, which is the bridge from a record in another system to a Zulip user id. Whether this resolves at all depends on the organization's email visibility setting: where addresses are hidden, only an administrator can look someone up this way.
Zulip: Get User Channels
zulip_get_user_channels
List the channel ids one person is subscribed to. The result is limited by what the acting account is allowed to see, so a short list can mean a narrow view rather than a quiet colleague. This path uses the new channels spelling while its sibling one level deeper still says subscriptions.
Zulip: Get User Group Members
zulip_get_user_group_members
List the user ids in a group. By default this includes people who are only in it through a subgroup, which is usually what a notification workflow wants; set direct_member_only to see the group's own roster instead.
Zulip: Get User Group Subgroups
zulip_get_user_group_subgroups
List the group ids nested inside a group. Groups nest arbitrarily deep, so leave direct_subgroup_only off to see the whole tree flattened.
Zulip: Get User Presence
zulip_get_user_presence
Read whether one person is currently active or idle, with the timestamps behind it. The path parameter is POLYMORPHIC: it accepts either a numeric user id or an email address, which is unusual on this API and is why the field is typed as a string.
Zulip: Get User Status
zulip_get_user_status
Read one person's status text and status emoji, which is the away or in a meeting line they set for themselves. Different from presence, which is whether they are online.
Zulip: List Alert Words
zulip_list_alert_words
List the words that notify the acting account whenever they appear in a message. Personal to that account and invisible to everyone else.
Zulip: List Allowed Domains
zulip_list_realm_domains
List the email domains allowed to join the organization. Empty usually means the organization is invitation only rather than open to everybody.
Zulip: List Attachments
zulip_list_attachments
List the files the acting account has uploaded, with the messages each one appears in and the total storage used. An attachment with an empty message_ids array is orphaned, which is what a storage cleanup workflow looks for.
Zulip: List Channel Folders
zulip_list_channel_folders
List the organization's channel folders, which group channels in the sidebar. This is the lister behind every folder picker here. The spec declares this GET's parameter under a request body; on a GET it travels in the query string.
Zulip: List Channel Topics
zulip_list_channel_topics
List the topics in a channel that the acting account can see, most recently active first, each with the id of its newest message. This is the lister behind every topic picker in this connector, which is why it takes the channel as a path parameter: a topic only means something inside one channel.
Zulip: List Channels
zulip_list_channels
List the organization's channels. This is the lister behind every channel picker in this connector. The path is /streams even though the product calls these channels: Zulip is midway through renaming streams to channels and the create endpoint has moved while the lister has not. Private channels the acting account cannot see are simply absent rather than reported as an error. Unpaginated: the whole set comes back in one response.
Zulip: List Custom Emoji
zulip_list_custom_emoji
List the organization's custom emoji. Note the SHAPE OF THE RESPONSE: emoji is an object keyed by emoji id rather than an array, so a workflow reads it by key rather than looping a list. That shape is also why custom emoji cannot back a picker in this connector.
Zulip: List Custom Profile Fields
zulip_list_custom_profile_fields
List the organization's custom profile fields with their ids, types and hints. Read this before writing profile data: the id is what every profile write takes, and the type decides the value format. Type 1 is short text, 2 long text, 3 a list of options, 4 a date, 5 a link, 6 a person, 7 an external account, 8 pronouns.
Zulip: List Drafts
zulip_list_drafts
List the acting account's synced drafts. Drafts are private to the account that owns them and are never delivered, which makes them the safest place for an automation to stage message text a person will review before sending.
Zulip: List Invitations
zulip_list_invites
List the organization's outstanding invitations. Both kinds come back in one array and are told apart by is_multiuse: an email invitation carries the address it went to, and a reusable link carries link_url. Treat link_url as sensitive, because anyone holding it can join the organization.
Zulip: List Linkifiers
zulip_list_linkifiers
List the organization's linkifiers, which turn patterns in message text into links, such as a ticket number becoming a link to the tracker. Note the path asymmetry with the write endpoints, which live under /realm/filters.
Zulip: List Reminders
zulip_list_reminders
List the reminders the acting account has set on messages. Each carries the message it points back at and when it will fire.
Zulip: List Saved Snippets
zulip_list_saved_snippets
List the acting account's saved snippets, which are reusable blocks of message text. Useful as a source of approved wording an automation can insert rather than composing prose itself.
Zulip: List Scheduled Messages
zulip_list_scheduled_messages
List the messages the acting account has queued for future delivery. A scheduled message that could not be delivered comes back with failed set to true, which is worth checking on a schedule because nothing else tells you.
Zulip: List Subscriptions
zulip_list_subscriptions
List the channels the acting account is subscribed to, with its own per channel settings such as colour, muting and notification preferences. Different from List Channels, which describes the organization; this describes one account's relationship to it.
Zulip: List User Groups
zulip_list_user_groups
List the organization's user groups, each with its direct members and subgroups. SYSTEM GROUPS ARE INCLUDED and are the ones with is_system_group true and names like role:members; they are Zulip's own role groups and cannot be edited. This is the lister behind every group picker here. The spec declares this GET's parameter under a request body; on a GET it travels in the query string.
Zulip: List Users
zulip_list_users
List everyone in the organization. This is the lister behind every person picker in this connector. BOTS AND DEACTIVATED ACCOUNTS ARE INCLUDED, told apart by is_bot and is_active, so filter downstream when you mean humans. Email addresses come back in delivery_email only when the organization's email visibility setting permits it, and are null otherwise. Unpaginated: the whole membership comes back in one response.
Zulip: Render Message Preview
zulip_render_message
Render Zulip Markdown to HTML without sending anything. This is the safe rehearsal for a send: it resolves mentions, channel links and emoji exactly as the real message would, and nobody is notified. Use it to check generated message text before a Send Channel Message node runs.
Action nodes 73
Zulip: API Request
zulip_api_request
Call any Zulip REST endpoint this connector does not ship as its own node, using the same site URL and credential. This exists because the catalog is curated: 42 of the API's current operations are deliberately not built, and this node reaches them without waiting for a release. It handles Zulip's form encoding for you, including the rule that non string values are JSON encoded inside the form. Prefer a purpose built node where one exists, because those carry the pickers, the defaults and the warnings.
Zulip: Add Alert Words
zulip_add_alert_words
Add words that will notify the acting account. Returns the full list afterwards, not just what was added, so the response is a complete picture rather than a diff.
Zulip: Add Allowed Domain
zulip_add_realm_domain
Allow an email domain to join the organization. This widens who can sign up, so it is a security change: adding a shared consumer mail domain effectively opens the organization to anyone. Administrator only.
Zulip: Add Code Playground
zulip_add_code_playground
Register an external code playground, so fenced code blocks in a given language get a button that opens the snippet there. Administrator only. The code is sent to whatever site the template names, so point it somewhere the organization is willing to paste source into.
Zulip: Add Default Channel
zulip_add_default_channel
Add a channel to the set every new member of the organization joins automatically. Administrator only. The path is /default_streams, one of the places the old spelling survives.
Zulip: Add Linkifier
zulip_add_linkifier
Create a linkifier. Administrator only, and it changes how EVERY message in the organization renders, including messages already sent, so a pattern that is too broad quietly turns ordinary text into links everywhere. The write path is /realm/filters even though the read path is /realm/linkifiers.
Zulip: Add Reaction
zulip_add_reaction
React to a message with an emoji, as the account holding the credential. For standard emoji the name alone is enough. A reaction is visible to everyone who can see the message, so this is a public acknowledgement rather than a private note.
Zulip: Archive Channel
zulip_archive_channel
Archive a channel. The HTTP verb is DELETE but the effect is archival: the channel and its messages stop appearing for members, and an administrator can restore it by setting is_archived to false with Update Channel. Every subscriber loses access at once, so this is disruptive even though it is reversible.
Zulip: Create Channel
zulip_create_channel
Create a channel and subscribe an initial set of people to it. Note the path: creating uses the NEW spelling at /channels/create while listing and updating still use /streams, which is the clearest sign the rename is unfinished. Turning announce on posts a notice to the organization's announcements channel, which reaches real people. is_web_public makes the channel readable by anyone on the internet.
Zulip: Create Channel Folder
zulip_create_channel_folder
Create a folder for grouping channels in the sidebar. Another path using the new create suffix, alongside /channels/create.
Zulip: Create Custom Profile Field
zulip_create_custom_profile_field
Add a custom profile field to the organization. Administrator only. field_type is a number: 1 short text, 2 long text, 3 list of options, 4 date, 5 link, 6 person, 7 external account, 8 pronouns. Marking a field required prompts every member to fill it in, which is visible to all of them.
Zulip: Create Drafts
zulip_create_drafts
Create one or more drafts for the acting account. Nothing is sent and nobody is notified: a draft is private to its owner until they choose to send it. This is the human in the loop pattern for a message an automation composed.
Zulip: Create Message Reminder
zulip_create_message_reminder
Ask Zulip to remind the acting account about a message at a future time. THIS REACHES A REAL PERSON when it fires, though only the account that owns the credential: the reminder arrives as a direct message from the reminder bot. Nothing is sent now.
Zulip: Create Reusable Invitation Link
zulip_create_invite_link
Mint a reusable join link. Nothing is emailed, which makes this the quieter half of invitations, but THE RETURNED LINK IS A CREDENTIAL: anyone who has it can join the organization at the role it encodes until it expires or is revoked. Do not post it anywhere the intended audience is not already the whole audience, and prefer a short expiry.
Zulip: Create Saved Snippet
zulip_create_saved_snippet
Save a reusable block of message text for the acting account. Private to that account and never delivered.
Zulip: Create Scheduled Message
zulip_create_scheduled_message
Queue a message for delivery at a future time. THIS REACHES REAL PEOPLE when it fires. Nothing is sent now, which makes this the gentler way to automate an announcement: the queued message is visible in Zulip and can be edited or deleted before its time. The delivery time is a Unix timestamp in seconds and must be in the future.
Zulip: Create User
zulip_create_user
Create an account directly, without an invitation. Administrator only, and it takes a PASSWORD, which means this node is only appropriate where the password is generated and delivered securely by something else. For normal onboarding, prefer Send Invitations, which lets the person set their own password. The password is never echoed back and is redacted from this node's output.
Zulip: Create User Group
zulip_create_user_group
Create a user group, which is a mentionable set of people that can also be granted permissions on channels. Another path using the create suffix rather than a bare POST to the collection.
Zulip: Deactivate Custom Emoji
zulip_deactivate_custom_emoji
Retire a custom emoji. Existing reactions and messages using it keep rendering; it stops being offered for new use. Uploading a new custom emoji is not built here because it takes raw image bytes; use the API Request passthrough or the Zulip web app.
Zulip: Deactivate User
zulip_deactivate_user
Deactivate an account. The person is signed out everywhere and cannot log in, and their messages stay. This is reversible with Reactivate User. Supplying a notification comment EMAILS THE PERSON, so leave it blank for a silent offboarding. On a paid Zulip Cloud plan a deactivation also frees the seat, which changes billing.
Zulip: Deactivate User Group
zulip_deactivate_user_group
Deactivate a user group. Zulip has no hard delete for groups, which is deliberate: a group may be named in channel permissions, and deactivating fails with a clear error while anything still depends on it.
Zulip: Delete Allowed Domain
zulip_delete_realm_domain
Stop allowing an email domain to join. Existing members with addresses at that domain keep their accounts.
Zulip: Delete Custom Profile Field
zulip_delete_custom_profile_field
Remove a custom profile field from the organization. EVERY MEMBER'S VALUE FOR IT IS DELETED WITH IT and there is no undo.
Zulip: Delete Draft
zulip_delete_draft
Delete one of the acting account's drafts.
Zulip: Delete Message
zulip_delete_message
Permanently delete a message. There is no undelete and no trash. Deleting does not recall a notification email or mobile push the message already triggered, so a deleted message can still have been read. Message deletion is restricted by organization policy and returns an error when the acting account is not permitted.
Zulip: Delete Reminder
zulip_delete_reminder
Cancel a reminder before it fires.
Zulip: Delete Saved Snippet
zulip_delete_saved_snippet
Delete one of the acting account's saved snippets.
Zulip: Delete Scheduled Message
zulip_delete_scheduled_message
Cancel a queued message so it is never delivered. This is the undo for Create Scheduled Message and the reason scheduling is safer than sending: before the delivery time there is still a way out.
Zulip: Delete Topic
zulip_delete_topic
Permanently delete every message in one topic of a channel. There is no undo. On a large topic the call may only get part way through, in which case complete comes back false and the node must be run again to finish, so treat a single success as incomplete until complete is true.
Zulip: Edit Draft
zulip_edit_draft
Replace a draft's contents. The whole draft object is sent, not a partial patch, so read the current draft first if you only mean to change one field.
Zulip: Edit Saved Snippet
zulip_edit_saved_snippet
Change a saved snippet's title or body. Only the fields you fill in are changed.
Zulip: Mute User
zulip_mute_user
Mute someone for the acting account, hiding their messages and notifications. Personal and invisible to the person muted.
Zulip: Reactivate User
zulip_reactivate_user
Restore a deactivated account. The person can log in again and their old subscriptions come back. On a paid Zulip Cloud plan this consumes a seat again.
Zulip: Remove Alert Words
zulip_remove_alert_words
Stop alerting on the given words. Returns the remaining list.
Zulip: Remove Attachment
zulip_remove_attachment
Permanently delete an uploaded file. Any message linking to it keeps the link and the link stops working, so prefer deleting attachments whose message_ids array is empty.
Zulip: Remove Code Playground
zulip_remove_code_playground
Remove a registered code playground. Zulip ships no endpoint that lists playgrounds, so the id comes from the create response or from the organization settings screen.
Zulip: Remove Default Channel
zulip_remove_default_channel
Take a channel out of the set new members join automatically. Existing members stay subscribed; this only changes what happens to the next person who joins.
Zulip: Remove Linkifier
zulip_remove_linkifier
Delete a linkifier. Messages that were rendering as links stop doing so, everywhere and immediately.
Zulip: Remove Own Profile Data
zulip_remove_profile_data
Clear custom profile field values on the account holding the credential. Takes field ids rather than objects, which is the asymmetry to watch: setting takes id and value pairs, clearing takes bare ids.
Zulip: Remove Reaction
zulip_remove_reaction
Remove a reaction the acting account previously added. It cannot remove anyone else's reaction; the API scopes this to the authenticated user.
Zulip: Report Message To Moderators
zulip_report_message
Flag a message for the organization's moderators. THIS REACHES REAL PEOPLE: it posts into the moderation request channel and notifies whoever moderates. Requires the organization to have a moderation request channel configured, and returns an error when it does not.
Zulip: Resend Email Invitation
zulip_resend_email_invite
Send an outstanding invitation email again and restart its expiry clock. THIS REACHES A REAL PERSON: it is another email to the same address, so a nagging automation on a short schedule is a way to send someone a great many emails.
Zulip: Revoke Email Invitation
zulip_revoke_email_invite
Cancel an outstanding email invitation so the link inside it stops working. The email itself has already been delivered and cannot be recalled.
Zulip: Revoke Reusable Invitation Link
zulip_revoke_invite_link
Disable a reusable join link. This is the containment action when a link has been shared more widely than intended, and it takes effect immediately. Note the separate path: a reusable link is not revoked through the email invitation endpoint even though both appear in the same list.
Zulip: Send Channel Message
zulip_send_channel_message
Post a message to a Zulip channel and topic. THIS REACHES REAL PEOPLE: every subscriber sees it immediately and it can trigger their email and mobile notifications, which deleting the message afterwards does not recall. Zulip has no test mode and no idempotency key, so a retried run posts the message twice. Rehearse with Render Message Preview, which renders the same Markdown and sends nothing. This node is the channel half of POST /messages; the direct message half is a separate node so the recipient picker can be correct on both.
Zulip: Send Direct Message
zulip_send_direct_message
Send a direct message to one or more people. THIS REACHES REAL PEOPLE and cannot be undone: deleting the message afterwards does not recall the notification it already sent. There is no idempotency key on this API, so a retried run sends twice. Listing more than one recipient creates a single group conversation among all of them rather than separate one to one messages.
Zulip: Send Invitations
zulip_send_invites
Email invitations to join the organization. THIS REACHES REAL PEOPLE: every address listed gets an email immediately, and there is no idempotency key, so a retried run emails everyone a second time. Revoking an invitation afterwards does not unsend the email. Channel ids are required by the API, so decide what the new members will join before running it.
Zulip: Set Topic Visibility Policy
zulip_update_user_topic
Mute, unmute or follow a topic for the acting account. This is the supported replacement for the retired muted topics endpoint. The policy is an integer rather than a word: 0 is inherit, 1 is muted, 2 is unmuted and 3 is followed.
Zulip: Subscribe To Channels
zulip_subscribe
Subscribe people to channels. Two behaviours to know before using it. First, THIS CREATES CHANNELS THAT DO NOT EXIST rather than failing, so a typo in a channel name silently creates a channel. Second, subscribing other people notifies them, and leaving send_new_subscription_messages on posts a welcome message into each channel. Subscribing someone else requires permission and fails otherwise.
Zulip: Test Welcome Bot Message
zulip_test_welcome_bot_message
Send yourself the welcome message a new member would receive, so the custom text can be checked before any invitation goes out. It reaches only the account holding the credential, which makes it the rehearsal step for Send Invitations.
Zulip: Unmute User
zulip_unmute_user
Stop muting someone for the acting account.
Zulip: Unsubscribe From Channels
zulip_unsubscribe
Remove people from channels. Note that the parameters travel in a urlencoded BODY on this DELETE, which is Zulip's documented shape. Unsubscribing someone from a private channel can cost them access to its history permanently, which no automation can give back.
Zulip: Update Allowed Domain
zulip_update_realm_domain
Change whether an already allowed domain also covers its subdomains.
Zulip: Update Channel
zulip_update_channel
Rename a channel, change its description, or change its privacy, folder and retention settings. Only the fields you fill in are changed. Making a public channel private does not retroactively hide what was already said in it unless history_public_to_subscribers is also changed, and changing retention can delete existing messages permanently.
Zulip: Update Channel Folder
zulip_update_channel_folder
Rename a channel folder, change its description, or archive it. Archiving a folder does not archive the channels inside it.
Zulip: Update Custom Profile Field
zulip_update_custom_profile_field
Change a custom profile field's label, hint or options. The field TYPE cannot be changed after creation, which is why it is absent here: a type change would invalidate every stored value.
Zulip: Update Linkifier
zulip_update_linkifier
Change a linkifier. Both pattern and url_template are required by the API even when only one of them is changing, so read the current values with List Linkifiers first and send both.
Zulip: Update Message
zulip_update_message
Edit a message, move it to a different topic, or move it to a different channel. Moving is the operation to be careful with: propagate_mode decides whether one message moves or the whole rest of the topic follows it, and change_all on a busy topic rewrites the location of every message in it.
Zulip: Update Message Flags
zulip_update_message_flags
Add or remove a flag on a list of messages for the acting account. Flags are per person, so this changes what the account holding the credential sees and nobody else. The read flag is the one automations use most, to mark a batch of messages handled.
Zulip: Update Message Flags For Narrow
zulip_update_message_flags_for_narrow
Flag every message matching a narrow, one anchored batch at a time. This is the supported replacement for the retired mark all as read endpoints. The response reports processed_count and found_newest so a workflow can loop until the whole narrow is done rather than assuming one call covered it.
Zulip: Update One Subscription Property
zulip_update_subscription_property
Change a single per channel preference for the acting account. The simple form of Update Subscription Settings, for when only one thing needs to change.
Zulip: Update Own Profile Data
zulip_update_profile_data
Set custom profile field values on the account holding the credential. Field ids come from List Custom Profile Fields, and the value format depends on the field type: plain text for a short text field, an ISO date for a date field, and a JSON encoded list of user ids for a person field.
Zulip: Update Own Status
zulip_update_status
Set the status text and emoji on the account holding the credential. Sending an empty status_text clears it, which is how a scheduled workflow puts a status up in the morning and takes it down again.
Zulip: Update Scheduled Message
zulip_update_scheduled_message
Change a queued message before it is delivered: its text, its destination, or when it goes out. Only the fields you fill in are changed. Fails once the message has already been sent.
Zulip: Update Status For User
zulip_update_status_for_user
Set another person's status text and emoji. Administrator only, and it changes something other people read as that person's own words, so use it for offboarding cleanup rather than for routine automation.
Zulip: Update Subscription Settings
zulip_update_subscription_settings
Change several per channel preferences for the acting account in one call: colour, muting, pinning and each notification channel. These are personal settings and affect nobody else.
Zulip: Update Subscriptions In Bulk
zulip_update_subscriptions
Subscribe and unsubscribe the acting account in one call, which is how a workflow reconciles a whole channel list without a race between two separate requests.
Zulip: Update User
zulip_update_user
Change a person's name, organization role or custom profile fields. Administrator only. Role is a number rather than a word: 100 owner, 200 administrator, 300 moderator, 400 member, 600 guest. Lowering someone to guest removes access to channels they are not explicitly subscribed to.
Zulip: Update User By Email
zulip_update_user_by_email
The same changes as Update User, addressed by email instead of user id, so a workflow driven by an HR or directory system does not need a lookup step first.
Zulip: Update User Group
zulip_update_user_group
Rename a user group or change its description. Only the fields you fill in are changed. System groups cannot be changed and return an error.
Zulip: Update User Group Members
zulip_update_user_group_members
Add and remove people from a group in one call. Removing someone can revoke channel access the group granted them, so this is a permissions change and not only a directory edit.
Zulip: Update User Group Subgroups
zulip_update_user_group_subgroups
Nest groups inside a group, or unnest them. Zulip rejects a change that would create a cycle.
Zulip: Upload File
zulip_upload_file
Upload a file to Zulip from a URL and get back the path to embed in a message. Zulip's own endpoint takes raw bytes, so this node downloads the URL you give it over https and forwards the bytes; the cap is 50 MB here and the organization's own upload limit applies on top. Embed the returned url in a message as a Markdown link to attach it.
Using the integration
The three field credential, and why two would not work
Zulip's own security scheme states that authentication is HTTP Basic with the user's email as the username and the API key as the password, so the email is half the credential rather than a label on it. The third field follows from how Zulip is deployed. Every organization is a separate realm on a separate hostname: on Zulip Cloud that is a subdomain, and a self hosted organization is its own server entirely. An API key is issued by exactly one realm and is meaningless at another, so there is no shared API host to send it to and no static URL that could verify an arbitrary Zulip credential. Mattering therefore builds the base URL from the credential's own site value and probes it. The site field accepts what people actually type: a bare name with no dot is read as a Zulip Cloud subdomain, a hostname is given an https scheme, and a pasted API root is trimmed back to the host. One input is refused rather than fixed, and deliberately so: a site that explicitly says http is rejected with a message instead of being silently upgraded, because Basic credentials over plain http are readable in transit and silently rewriting a stated intent about transport security is worse than failing loudly.
Channels and streams, and why both words appear below
Zulip renamed streams to channels and the rename is not finished, so both words are in the current API at the same time. This integration does not paper over it. Node names use channel, because that is the word the product uses and the word you will type into the palette search: Zulip: List Channels, Zulip: Create Channel, Zulip: Archive Channel, Zulip: Get Channel ID By Name. Configuration fields keep the wire spelling, stream_id and stream, because that is what the API takes. Renaming a config field would be a quiet lie about the request being sent, and it would break the first time you compared a workflow against Zulip's own API documentation, which still uses the old spelling on the same endpoints. The unevenness is genuinely inside the path set rather than merely historical: the endpoint that creates one uses the new spelling while the lister for the same resource uses the old one, and two sibling paths under the same prefix disagree with each other. Every path in this integration is taken from the spec individually rather than generated from a resource name, because a generator would produce the tidy new spelling for endpoints that have not moved and return a 404 that reads exactly like a permissions problem. If Zulip finishes the rename, the field names change and the node names do not, which is the right way round: a node name is the stable palette identifier and renaming one orphans every workflow using it.
What reaches real people, and how to rehearse it
Six nodes deliver something a person receives, and each carries the warning in its own description on the canvas. Zulip: Send Channel Message reaches every subscriber of the channel immediately. Zulip: Send Direct Message reaches the named recipients, and listing more than one creates a single group conversation among all of them rather than separate one to one messages. Zulip: Create Scheduled Message and Zulip: Create Message Reminder reach their destination at the scheduled time, the reminder only ever reaching the account holding the credential. Zulip: Send Invitations emails every address listed, and Zulip: Resend Email Invitation emails one of them again. There is no test mode and no sandbox, and deleting a message afterwards does not recall the notification email or the mobile push it already triggered, so a deleted message can still have been read. Two rehearsals are built and are pointed at from the send nodes. Zulip: Render Message Preview renders the same Markdown to HTML, resolving mentions, channel links and emoji exactly as the real message would, and sends nothing, which is the way to check generated text before it can page anybody. Zulip: Create Drafts stores a draft visible only to the acting account, which is the human in the loop pattern for automation composed text. Zulip: Test Welcome Bot Message is the equivalent rehearsal for invitations, sending the welcome copy to your own account only.
There are no idempotency keys on this API
Zulip has no idempotency key on any endpoint, and the local id field on message sending is not one: it is an echo field a client uses for its own optimistic rendering, and the server does not deduplicate on it. So a retried send posts the message twice, and the guard has to live in your workflow. In practice that means one of three shapes. Record what has already been sent, in a Mattering database or on the record that triggered the run, and gate the send on a condition that reads it first. Or send from a step that cannot retry, keeping the send as the last action in the run rather than in the middle of a sequence that might restart. Or use Zulip: Create Scheduled Message instead, because a queued message is visible in Zulip and can be edited or deleted before its delivery time, which is the closest thing to an undo this API offers. If a workflow is user triggered, such as a form submission, the deduplication has to be on the submitting side, because this connector cannot make a double submission safe on its own.
Reading history, and how paging actually works
Zulip: Get Messages is the only paginated endpoint in this integration and it does not page the way most APIs do. It is anchor based rather than offset or cursor based: you name an anchor, which is a message id or one of a small set of words such as newest or oldest, ask for a number of messages before it and after it, and read the found oldest and found newest flags in the response to know whether the history ran out. Walking backwards through a channel therefore means anchoring on the oldest id you already hold, asking for a count backwards with the anchor excluded, and repeating until the found oldest flag comes back true. The narrow parameter filters by channel, topic, sender, mentions, text and message flags, and is the right place to scope a read rather than fetching broadly and filtering afterwards. Note what it does not have: there is no date operator in a narrow, Zulip's search operators cover channel, topic, sender, direct messages, mentions, text, attachments and message flags but nothing resembling a before or after filter, so a time window has to be approximated through message ids rather than requested directly. One plan boundary sits on this node specifically. Zulip documents 10,000 messages of search history on the free Cloud plan and unlimited search history on its paid plans, so a text search narrow on a busy free organization can stop returning results before the channel actually runs out. Read the found oldest flag rather than assuming an empty page means the end of the history. Almost every other list endpoint on this API is unpaginated and returns the whole collection in one response, including channels, users, user groups, attachments, invitations and drafts, which is fine for most organizations and worth knowing before you point one at a very large one. This integration does not auto paginate anywhere, deliberately, so an unbounded number of requests never hides behind a single canvas step.
Success responses that quietly did nothing
Zulip can answer a request successfully while silently dropping request parameters it did not recognise, naming them in a list on the response body. The request returns success, it looks like it worked, and the thing you asked for did not happen. This integration copies that list onto the node output with an explanatory hint rather than swallowing it, because on this API it is usually a version signal rather than a typo. Zulip gates capability by an integer server feature level rather than by anything in the URL, so a self hosted organization a few releases behind the parameter you are using drops it exactly this way while reporting success. Zulip Cloud tracks the current release, so this is almost always a self hosted question. Zulip: Get Server Settings returns the server version and its feature level, needs no credential at all, and is the cheapest first call when a node behaves in a way the documentation does not describe. The same node is a useful reachability check on a site value, since it will answer on a correct host before any credential is involved.
Deletes, archives and the two that look safe
The destructive nodes here are not one thing. Zulip: Archive Channel uses the DELETE method but archives rather than destroys: the channel and its messages stop appearing for members and an administrator can restore it, though every subscriber loses access at once, so it is disruptive even though it is reversible. Zulip: Deactivate User is also reversible, with Zulip: Reactivate User, and leaves the person's messages in place, but supplying a notification comment emails them, so leave it blank for a silent offboarding. The permanent ones are Zulip: Delete Message, which has no undelete and no trash, Zulip: Delete Topic, which removes every message in a topic and can only get part way through a large one, reporting an incomplete flag that means it must be run again, Zulip: Delete Custom Profile Field, which takes every member's value for that field with it, and Zulip: Remove Attachment, where any message linking to the file keeps the link and the link stops working. Two more are dangerous in a way the HTTP method does not show. Zulip: Subscribe To Channels creates a channel that does not exist rather than failing, so a typo in a templated channel name silently creates one. And Zulip: Create Reusable Invitation Link returns a credential: anyone holding the link can join the organization at the role it encodes until it expires or is revoked, which is what Zulip: Revoke Reusable Invitation Link is for.
Pickers, and the fields that stay free text
Most id fields in this integration are pickers fed by a lister in the same connector, so a channel field offers channel names rather than integers and a person field offers people. Two are worth knowing about. The person picker is labelled by email address rather than by display name alone, because a Zulip organization routinely holds two people with the same display name and lists bots beside humans, and the email is what disambiguates at the moment you have to choose correctly. The topic picker is dependent: topics are not entities and have no ids of their own, they are strings scoped to one channel, and the lister behind them takes the channel as a path parameter. So a topic picker cannot populate until a channel has been chosen, and it repopulates when the channel changes. Some fields are free text by design rather than broken pickers. Every field that takes a list of ids stays free text with the JSON shape spelled out in its help, because a picker resolves one value and would store a single id where the API needs a list. Message ids are free text because no endpoint lists messages in a form a picker could scan and a message id almost always arrives from an upstream node anyway. Each of those field descriptions names the lister that supplies the ids you need.
From AI assistants over MCP
Every node speaks MCP, the open protocol for connecting AI assistants to tools, so Claude, ChatGPT, and Matter, the assistant built into the platform, can drive the same surface. On whether Zulip ships an MCP server of its own, the honest answer is that the public evidence is unresolved and we are not going to pretend otherwise. What is observable: a repository named zulipmcp sits in Zulip's own GitHub organization; its README's install command and its licence badge link both point at a repository of the same name under a different organization, which GitHub in turn records as a fork of the one in Zulip's organization; Zulip's own website does not mention MCP or the Model Context Protocol anywhere, and the repository is not referenced in the API documentation navigation on zulip.com; and its README does not enumerate the tools it exposes. Read those facts yourself rather than trusting any page that resolves them confidently in either direction. What does not depend on that comparison is the shape of what you get here. These 113 nodes are also canvas steps, so a workflow an assistant helps you design then runs on a schedule with nobody present, chains with every other connector in the same run, holds one credential in a shared workspace rather than in each person's local configuration, and carries destructive flags. With a chat tool specifically, the sensible split is to give an assistant the 40 read nodes freely and keep the six that reach real people behind a condition or an approval step, because an assistant that can post to a channel can notify everyone in it.
What is not built, and how to reach it anyway
This is a curated catalog. Zulip's API description carries 167 operations, of which 153 are callable by a client once you set aside the deprecated ones, the two that exist only on a Zulip development server, and three documentation pages Zulip carries as fake paths because it renders its API docs from the same file. This integration builds 111 of those 153 and leaves 42 out on stated criteria: the endpoints that mint or return API keys, which would put a live credential into an automation payload; the event queue, which is Zulip's real time surface and belongs to a trigger rather than a canvas node, since it long polls and holds a connection open until an event arrives; raw image uploads for avatars and custom emoji; the endpoints that only mean anything inside a Zulip client, such as typing notifications, presence updates and device registration; the two settings endpoints that carry around sixty options each and would render as a wall of controls; whole organization deactivation and data export; list reordering; and the video call endpoints, which depend on a third party being configured on the server. Zulip: API Request is the advanced escape hatch that reaches any of them: it calls any Zulip API endpoint with the same site and credential, and it handles the form encoding, including the rule that non string values are JSON encoded inside the form body, so a passthrough call is not a re-derivation of the wire format. Prefer a purpose built node where one exists, because those carry the pickers, the defaults and the warnings.
Troubleshooting
Test Connection fails with a 401
A node fails with a 403 while other nodes work
Everything returns 404, including endpoints that obviously exist
The connection was refused because the site uses http
A node reported success but nothing changed in Zulip
A message was sent twice
A channel appeared that nobody meant to create
A channel or a private conversation is missing from a list
A topic picker will not populate
Requests start failing partway through a run with a 429
An id from one picker is rejected by a different node
A node exists in Zulip's documentation but not in the palette
Related
The Zulip MCP
What connecting Zulip unlocks for AI agents and automations, with common uses and FAQs.
More guides
All Automations documentation
Every integration guide, plus how connectors, credentials, and workflows fit together.
Zulip is a trademark of its respective owner. Mattering uses platform names to identify the services these integrations connect to; no endorsement or affiliation is implied.