> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Zulip

The Zulip connector lets your AI agent act in each user's Zulip account. Each user connects their own Zulip API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.

**Authentication:** Email + API Key
**Categories:** Communication, Collaboration
**Tools:** 59: 27 read, 23 write, 9 destructive
**Users sign in with:** Username and password
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=ZULIP)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Zulip connection

   In **AgentKit > Connections**, create a Zulip connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'zulip_channel_get',
  toolInput: {
    stream_id: 15,
  },
  connector: 'zulip',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="zulip_channel_get",
    tool_input={
        "stream_id": 15,
    },
    connection_name="zulip",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `zulip_channel_get`

Get Channel · Read-only

Get one channel by ID.
Returns stream with name, description, privacy settings and permissions.
Use zulip_channel_get when you have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `stream_id` (`integer`, required): ID of the channel (get it from zulip_channels_list or zulip_channel_id_get). Example: 15.

Example input: `{"stream_id":15}`

### `zulip_channel_id_get`

Get Channel ID · Read-only

Look up a channel's ID by name.
Returns stream_id.
Use zulip_channel_id_get before tools that take a stream_id.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `stream` (`string`, required): Channel name. Example: general.

Example input: `{"stream":"<stream>"}`

### `zulip_channel_subscribers_list`

List Channel Subscribers · Read-only

List the users subscribed to a channel.
Returns subscribers[], user IDs.
Use zulip_channel_subscribers_list to see who is in a channel.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `stream_id` (`integer`, required): ID of the channel (get it from zulip_channels_list or zulip_channel_id_get). Example: 15.

Example input: `{"stream_id":15}`

### `zulip_channel_topics_list`

List Channel Topics · Read-only

List a channel's topics, most recent first.
Returns topics[] with name and max_id.
Use zulip_channel_topics_list before reading a topic with zulip_messages_get.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `stream_id` (`integer`, required): ID of the channel (get it from zulip_channels_list or zulip_channel_id_get). Example: 15.

Example input: `{"stream_id":15}`

### `zulip_channels_list`

List Channels · Read-only

List channels (streams) you can see, optionally including all public, web-public or archived ones.
Returns streams[] with stream_id, name, description, invite_only and is_archived.
Use zulip_channels_list to find a channel ID. Use zulip_subscriptions_list for channels you are in.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `exclude_archived` (`boolean`, optional): Leave out archived channels. Defaults to true. Example: true.
- `include_public` (`boolean`, optional): Include all public channels. Defaults to true. Example: true.
- `include_subscribed` (`boolean`, optional): Include channels you are subscribed to. Defaults to true. Example: true.
- `include_web_public` (`boolean`, optional): Include web-public channels. Defaults to false. Example: false.

Example input: `{}`

### `zulip_custom_emoji_list`

List Custom Emoji · Read-only

List the organization's custom emoji.
Returns emoji keyed by ID with name, source_url and deactivated.
Use zulip_custom_emoji_list to find custom emoji names for reactions.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `zulip_drafts_list`

List Drafts · Read-only

List your message drafts.
Returns drafts[] with id, type, to, topic, content and timestamp.
Use zulip_drafts_list to find saved drafts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `zulip_invites_list`

List Invitations · Read-only

List pending email invitations and reusable invite links.
Returns invites[] with id, email, invited_as and expiry.
Use zulip_invites_list to review open invitations.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `zulip_me_get`

Get Own User · Read-only

Get the user the API key belongs to.
Returns user_id, email, full_name, role and is_bot.
Use zulip_me_get to check the connection.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `zulip_message_get`

Get Message · Read-only

Get one message by ID.
Returns message with sender, content, timestamp, topic, reactions and flags (raw_content when apply_markdown is false).
Use zulip_message_get when you have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `message_id` (`integer`, required): ID of the message. Example: 43.
- `apply_markdown` (`boolean`, optional): true for rendered HTML, false for raw Markdown. Defaults to true. Example: false.

Example input: `{"message_id":43}`

### `zulip_message_history_get`

Get Message Edit History · Read-only

Get the edit history of a message.
Returns message_history[] with each version's content, topic, timestamp and editor.
Use zulip_message_history_get to see what changed.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `message_id` (`integer`, required): ID of the message. Example: 43.

Example input: `{"message_id":43}`

### `zulip_message_read_receipts_get`

Get Message Read Receipts · Read-only

List the users who have read a message.
Returns user_ids[].
Use zulip_message_read_receipts_get to check who saw an announcement.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `message_id` (`integer`, required): ID of the message. Example: 43.

Example input: `{"message_id":43}`

### `zulip_message_render`

Render Message · Read-only

Render Zulip Markdown to HTML without sending anything.
Returns rendered HTML.
Use zulip_message_render to preview a message.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `content` (`string`, required): Markdown to render. Example: **Release** on _Friday_.

Example input: `{"content":"<content>"}`

### `zulip_messages_get`

Get Messages · Read-only

Get messages around an anchor, optionally filtered by a narrow (channel, topic, sender, search terms).
Returns messages[] with id, sender, content, timestamp, topic and flags, plus found_anchor, found_oldest and found_newest.
Use zulip_messages_get to read or search conversations. Use zulip_message_get for one message by ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `anchor` (`string`, optional): Message ID to center on, or newest, oldest or first_unread. Defaults to newest. Example: newest.
- `apply_markdown` (`boolean`, optional): true for rendered HTML content, false for raw Markdown. Defaults to true. Example: false.
- `include_anchor` (`boolean`, optional): Whether to include the anchor message itself. Defaults to true. Example: true.
- `narrow` (`string`, optional): JSON-encoded array of filters, each {"operator": ..., "operand": ...}; operators include channel, topic, sender, dm, search, is (unread, starred, mentioned) and has (link, attachment). Example: [{"operator": "channel", "operand": "general"}, {"operator": "search", "operand": "release"}].
- `num_after` (`integer`, optional): Messages to return after the anchor, up to 5000. Example: 0.
- `num_before` (`integer`, optional): Messages to return before the anchor, up to 5000. Example: 20.

Example input: `{}`

### `zulip_presence_list`

List Presence of All Users · Read-only

Get the presence of every user in the organization.
Returns presences keyed by email with each client's status and timestamp.
Use zulip_presence_list to see who is online.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `zulip_profile_fields_list`

List Custom Profile Fields · Read-only

List the organization's custom profile fields.
Returns custom_fields[] with id, name, type and hint.
Use zulip_profile_fields_list to understand user profile data.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `zulip_reminders_list`

List Reminders · Read-only

List your message reminders.
Returns reminders[] with reminder_id, message, note and scheduled_delivery_timestamp.
Use zulip_reminders_list to see upcoming reminders.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `zulip_scheduled_messages_list`

List Scheduled Messages · Read-only

List your scheduled messages.
Returns scheduled_messages[] with scheduled_message_id, type, to, topic, content and scheduled_delivery_timestamp.
Use zulip_scheduled_messages_list before editing or cancelling one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `zulip_server_settings_get`

Get Server Settings · Read-only

Get the server's version, authentication methods and organization basics.
Returns zulip_version, zulip_feature_level, realm_name and authentication_methods.
Use zulip_server_settings_get to check which features the server supports.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `zulip_subscriptions_list`

List Subscribed Channels · Read-only

List the channels you are subscribed to, with your settings for each.
Returns subscriptions[] with stream_id, name, color, pin_to_top and muting.
Use zulip_subscriptions_list for your channels.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include_subscribers` (`boolean`, optional): Include each channel's subscriber IDs. Example: false.

Example input: `{}`

### `zulip_user_get`

Get User · Read-only

Get one user by ID.
Returns user with email, full_name, role, is_active, timezone and avatar.
Use zulip_user_get when you have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`integer`, required): ID of the user. Example: 12.
- `include_custom_profile_fields` (`boolean`, optional): Include custom profile fields. Example: false.

Example input: `{"user_id":12}`

### `zulip_user_get_by_email`

Get User by Email · Read-only

Get one user by email address.
Returns user with user_id, full_name, role and is_active.
Use zulip_user_get_by_email when you know the email.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email` (`string`, required): User's Zulip email address. Example: iago@zulip.example.com.

Example input: `{"email":"<email>"}`

### `zulip_user_group_members_get`

Get User Group Members · Read-only

List a user group's members.
Returns members[], user IDs.
Use zulip_user_group_members_get to see who is in a group.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `user_group_id` (`integer`, required): ID of the user group. Example: 7.
- `direct_member_only` (`boolean`, optional): Only direct members, not those via subgroups. Example: false.

Example input: `{"user_group_id":7}`

### `zulip_user_groups_list`

List User Groups · Read-only

List user groups.
Returns user_groups[] with id, name, description, members and direct_subgroup_ids.
Use zulip_user_groups_list to find a group ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `zulip_user_presence_get`

Get User Presence · Read-only

Get a user's presence (active or idle) per client.
Returns presence with aggregated status and timestamp.
Use zulip_user_presence_get to see whether someone is online.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `user_id_or_email` (`string`, required): User ID or email. Example: 12.

Example input: `{"user_id_or_email":"<user_id_or_email>"}`

### `zulip_user_status_get`

Get User Status · Read-only

Get a user's status text and emoji.
Returns status with status_text, emoji_name and away.
Use zulip_user_status_get to see if someone is on vacation.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`integer`, required): ID of the user. Example: 12.

Example input: `{"user_id":12}`

### `zulip_users_list`

List Users · Read-only

List all users in the organization, including bots.
Returns members[] with user_id, email, full_name, role, is_active and timezone.
Use zulip_users_list to find a user ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include_custom_profile_fields` (`boolean`, optional): Include custom profile fields. Example: false.

Example input: `{}`

### `zulip_channel_create`

Create Channel · Write

Create a channel and subscribe users to it.
Returns id, the new channel's ID.
Use zulip_channel_create for a new channel; use zulip_subscription_add to join existing ones.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Channel name. Example: release-team.
- `subscribers` (`string`, required): JSON-encoded array of user IDs to subscribe, for example [17, 12]. Example: [17, 12]
- `announce` (`boolean`, optional): Announce the new channel in the notifications channel. Example: true.
- `description` (`string`, optional): Channel description. Example: Release coordination.
- `history_public_to_subscribers` (`boolean`, optional): Let new subscribers see older messages (private channels). Example: true.
- `invite_only` (`boolean`, optional): true for a private channel. Example: false.
- `topics_policy` (`string`, optional): Whether empty topics are allowed in the channel. Example: inherit. One of: `inherit`, `allow_empty_topic`, `disable_empty_topic`, `empty_topic_only`.

Example input: `{"name":"<name>","subscribers":"<subscribers>"}`

### `zulip_channel_update`

Update Channel · Write

Update a channel's name, description, privacy or archive state.
Returns result success.
Use zulip_channel_update to rename or archive/unarchive a channel.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `stream_id` (`integer`, required): ID of the channel (get it from zulip_channels_list or zulip_channel_id_get). Example: 15.
- `description` (`string`, optional): New description. Example: Release coordination and go/no-go.
- `history_public_to_subscribers` (`boolean`, optional): Let new subscribers see older messages. Example: true.
- `is_archived` (`boolean`, optional): false to unarchive an archived channel. Example: false.
- `is_default_stream` (`boolean`, optional): Subscribe new users by default. Example: false.
- `is_private` (`boolean`, optional): true to make the channel private. Example: false.
- `is_web_public` (`boolean`, optional): true to make it web-public. Example: false.
- `new_name` (`string`, optional): New channel name. Example: release-crew.
- `topics_policy` (`string`, optional): Whether empty topics are allowed in the channel. Example: inherit. One of: `inherit`, `allow_empty_topic`, `disable_empty_topic`, `empty_topic_only`.

Example input: `{"stream_id":15}`

### `zulip_draft_create`

Create Drafts · Write

Save one or more message drafts.
Returns ids[] of the new drafts.
Use zulip_draft_create to save a message without sending it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `drafts` (`string`, required): JSON-encoded array of drafts, each with type (stream or private), to (array of IDs), topic, content and timestamp. Example: [{"type": "stream", "to": [15], "topic": "questions", "content": "Draft text", "timestamp": 1795000000}].

Example input: `{"drafts":"<drafts>"}`

### `zulip_invite_link_create`

Create Reusable Invite Link · Write

Create a reusable invitation link.
Returns invite_link.
Use zulip_invite_link_create to share one link with several people.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `invite_as` (`integer`, optional): Role for users who join. Example: 400. One of: `100`, `200`, `300`, `400`, `600`.
- `invite_expires_in_minutes` (`integer`, optional): Minutes until the link expires. Example: 10080.
- `stream_ids` (`string`, optional): JSON-encoded array of channel IDs new users join. Example: [15]

Example input: `{}`

### `zulip_invite_send`

Send Invitations · Write

Email invitations to join the organization.
Returns result success.
Use zulip_invite_send to invite people; they choose their own password.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `invitee_emails` (`string`, required): Comma- or newline-separated emails to invite. Example: alex@example.com, sam@example.com.
- `stream_ids` (`string`, required): JSON-encoded array of channel IDs the invitees join, for example [15]. Example: [15]
- `invite_as` (`integer`, optional): Role: 100 owner, 200 administrator, 300 moderator, 400 member (default), 600 guest. Example: 400. One of: `100`, `200`, `300`, `400`, `600`.
- `invite_expires_in_minutes` (`integer`, optional): Minutes until the invitation expires. Example: 10080.

Example input: `{"invitee_emails":"<invitee_emails>","stream_ids":"<stream_ids>"}`

### `zulip_message_flags_update`

Update Message Flags · Write

Add or remove a personal flag (read, starred, collapsed) on messages.
Returns messages[], the IDs changed.
Use zulip_message_flags_update to mark messages read or starred.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `flag` (`string`, required): Flag to change. Example: read. One of: `read`, `starred`, `collapsed`.
- `messages` (`string`, required): JSON-encoded array of message IDs, for example [4, 8, 15]. Example: [4, 8, 15]
- `op` (`string`, required): add or remove the flag. Example: add. One of: `add`, `remove`.

Example input: `{"flag":"read","messages":"<messages>","op":"add"}`

### `zulip_message_reaction_add`

Add Emoji Reaction · Write

Add an emoji reaction to a message.
Returns result success.
Use zulip_message_reaction_add to acknowledge a message.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `emoji_name` (`string`, required): Emoji name, for example thumbs_up or octopus. Example: thumbs_up.
- `message_id` (`integer`, required): ID of the message. Example: 43.
- `emoji_code` (`string`, optional): Emoji code, for a custom or ambiguous emoji. Example: 1f44d.
- `reaction_type` (`string`, optional): unicode_emoji, realm_emoji (custom) or zulip_extra_emoji. Example: unicode_emoji. One of: `unicode_emoji`, `realm_emoji`, `zulip_extra_emoji`.

Example input: `{"emoji_name":"<emoji_name>","message_id":43}`

### `zulip_message_send`

Send Message · Write

Send a message to a channel topic or as a direct message.
Returns id, the new message's ID.
Use zulip_message_send to post. Use zulip_scheduled_message_create to send later.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `content` (`string`, required): Message text in Zulip Markdown. Example: Hello team, the release is on Friday.
- `to` (`string`, required): Recipients: for a channel message the channel name or ID; for a direct message a JSON-encoded array of user IDs or emails, for example [9, 10]. Example: [9, 10]
- `type` (`string`, required): channel for a channel message, direct for a direct message. Example: channel. One of: `channel`, `direct`.
- `topic` (`string`, optional): Topic of a channel message (required for channel messages unless the channel allows empty topics). Example: Release planning.

Example input: `{"content":"<content>","to":"<to>","type":"channel"}`

### `zulip_message_update`

Edit Message · Write

Edit a message's content, or move it (and optionally the rest of its topic) to another topic or channel.
Returns result success and detached_uploads.
Use zulip_message_update to fix a typo or rename/move a topic.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `message_id` (`integer`, required): ID of the message. Example: 43.
- `content` (`string`, optional): New message text in Zulip Markdown. Example: Hello team, the release moved to Monday.
- `propagate_mode` (`string`, optional): Which messages a topic or channel move applies to: change_one, change_later or change_all. Defaults to change_one. Example: change_all. One of: `change_one`, `change_later`, `change_all`.
- `send_notification_to_new_thread` (`boolean`, optional): Post a notice in the new topic after a move. Example: true.
- `send_notification_to_old_thread` (`boolean`, optional): Post a notice in the old topic after a move. Example: false.
- `stream_id` (`integer`, optional): ID of the channel to move the message to. Example: 15.
- `topic` (`string`, optional): New topic name. Example: Release planning (moved)

Example input: `{"message_id":43}`

### `zulip_my_status_update`

Update My Status · Write

Set your own status text and emoji.
Returns result success.
Use zulip_my_status_update to set an out-of-office status; send empty text to clear it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `emoji_name` (`string`, optional): Status emoji name. Example: palm_tree.
- `status_text` (`string`, optional): Status text, up to 60 characters; empty clears it. Example: On vacation until Monday.

Example input: `{}`

### `zulip_reminder_create`

Create Message Reminder · Write

Set a reminder about a message; Zulip sends you a direct message at that time.
Returns reminder_id.
Use zulip_reminder_create to follow up on a message later.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `message_id` (`integer`, required): ID of the message to be reminded about. Example: 43.
- `scheduled_delivery_timestamp` (`integer`, required): When to remind, as a UNIX timestamp in seconds. Example: 1795000000.
- `note` (`string`, optional): Note to include in the reminder. Example: Reply to this before the meeting.

Example input: `{"message_id":43,"scheduled_delivery_timestamp":1795000000}`

### `zulip_scheduled_message_create`

Create Scheduled Message · Write

Schedule a message to be sent at a future time.
Returns scheduled_message_id.
Use zulip_scheduled_message_create to send later. Use zulip_message_send to send now.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `content` (`string`, required): Message text in Zulip Markdown. Example: Hello team, the release is on Friday.
- `scheduled_delivery_timestamp` (`integer`, required): When to send, as a UNIX timestamp in seconds. Example: 1795000000.
- `to` (`string`, required): Recipients: for a channel message the channel name or ID; for a direct message a JSON-encoded array of user IDs or emails, for example [9, 10]. Example: [9, 10]
- `type` (`string`, required): channel for a channel message, direct for a direct message. Example: channel. One of: `channel`, `direct`.
- `topic` (`string`, optional): Topic of a channel message (required for channel messages unless the channel allows empty topics). Example: Release planning.

Example input: `{"content":"<content>","scheduled_delivery_timestamp":1795000000,"to":"<to>","type":"channel"}`

### `zulip_scheduled_message_update`

Edit Scheduled Message · Write

Change a scheduled message's content, recipients, topic or send time.
Returns result success.
Use zulip_scheduled_message_update to reschedule.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `scheduled_message_id` (`integer`, required): ID of the scheduled message. Example: 41.
- `content` (`string`, optional): New message text. Example: Updated: release on Monday.
- `scheduled_delivery_timestamp` (`integer`, optional): New send time as a UNIX timestamp in seconds. Example: 1795003600.
- `to` (`string`, optional): New recipients: channel ID, or a JSON-encoded array of user IDs. Example: 15.
- `topic` (`string`, optional): New topic. Example: Release planning.
- `type` (`string`, optional): channel or direct. Example: channel. One of: `channel`, `direct`.

Example input: `{"scheduled_message_id":41}`

### `zulip_subscription_add`

Subscribe to Channels · Write

Subscribe yourself or other users to channels, creating channels that do not exist.
Returns subscribed, already_subscribed and unauthorized.
Use zulip_subscription_add to join or add people to channels.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `subscriptions` (`string`, required): JSON-encoded array of channels, each {"name": ..., "description": ...}. Example: [{"name": "release-team"}].
- `announce` (`boolean`, optional): Announce channels this call creates. Example: false.
- `invite_only` (`boolean`, optional): Private, for channels this call creates. Example: false.
- `principals` (`string`, optional): JSON-encoded array of user IDs or emails to subscribe; defaults to you. Example: [12, 17]

Example input: `{"subscriptions":"<subscriptions>"}`

### `zulip_subscription_update`

Update Subscription Setting · Write

Change one of your settings for a channel (color, mute, pin, notifications).
Returns result success.
Use zulip_subscription_update to mute or pin a channel.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `property` (`string`, required): Setting to change. Example: is_muted. One of: `color`, `is_muted`, `in_home_view`, `pin_to_top`, `desktop_notifications`, `audible_notifications`, `push_notifications`, `email_notifications`, `wildcard_mentions_notify`.
- `stream_id` (`integer`, required): ID of the channel (get it from zulip_channels_list or zulip_channel_id_get). Example: 15.
- `value` (`string`, required): New value: true or false, or a hex color for color. Example: true.

Example input: `{"property":"color","stream_id":15,"value":"<value>"}`

### `zulip_topic_preference_update`

Update Topic Preference · Write

Mute, unmute, follow or unmute-in-muted-channel a topic for yourself.
Returns result success.
Use zulip_topic_preference_update to mute or follow a topic.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `stream_id` (`integer`, required): ID of the channel. Example: 15.
- `topic` (`string`, required): Topic name. Example: Release planning.
- `visibility_policy` (`integer`, required): 0 none, 1 muted, 2 unmuted, 3 followed. Example: 3. One of: `0`, `1`, `2`, `3`.

Example input: `{"stream_id":15,"topic":"<topic>","visibility_policy":3}`

### `zulip_typing_set`

Set Typing Status · Write

Send a typing start or stop notification.
Returns result success.
Use zulip_typing_set before a long reply.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `op` (`string`, required): start or stop. Example: start. One of: `start`, `stop`.
- `stream_id` (`integer`, optional): For channel: channel ID. Example: 15.
- `to` (`string`, optional): For direct: JSON-encoded array of user IDs. Example: [9, 10]
- `topic` (`string`, optional): For channel: topic. Example: Release planning.
- `type` (`string`, optional): direct or channel. Defaults to direct. Example: channel. One of: `direct`, `channel`.

Example input: `{"op":"start"}`

### `zulip_user_create`

Create User · Write

Create a user account (organization administrators with permission only).
Returns user_id.
Use zulip_user_create to add a teammate; use zulip_invite_send to invite by email instead.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, required): Email of the new user. Example: new.user@example.com.
- `full_name` (`string`, required): Full name. Example: New User.
- `password` (`string`, required): Initial password. Example: S3cure-initial-pass.

Example input: `{"email":"<email>","full_name":"<full_name>","password":"<password>"}`

### `zulip_user_group_create`

Create User Group · Write

Create a user group.
Returns group_id.
Use zulip_user_group_create for a mentionable team such as @release-team.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `description` (`string`, required): Group description. Example: People shipping releases.
- `members` (`string`, required): JSON-encoded array of user IDs, for example [12, 17]. Example: [12, 17]
- `name` (`string`, required): Group name. Example: release-team.

Example input: `{"description":"<description>","members":"<members>","name":"<name>"}`

### `zulip_user_group_members_update`

Update User Group Members · Write

Add or remove members of a user group.
Returns result success.
Use zulip_user_group_members_update to change a group's membership.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `user_group_id` (`integer`, required): ID of the user group. Example: 7.
- `add` (`string`, optional): JSON-encoded array of user IDs to add. Example: [21]
- `delete` (`string`, optional): JSON-encoded array of user IDs to remove. Example: [17]

Example input: `{"user_group_id":7}`

### `zulip_user_group_update`

Update User Group · Write

Rename a user group or change its description.
Returns result success.
Use zulip_user_group_update to edit a group.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `user_group_id` (`integer`, required): ID of the user group. Example: 7.
- `description` (`string`, optional): New description. Example: People shipping releases and hotfixes.
- `name` (`string`, optional): New name. Example: release-crew.

Example input: `{"user_group_id":7}`

### `zulip_user_reactivate`

Reactivate User · Write

Reactivate a deactivated user.
Returns result success.
Use zulip_user_reactivate to restore access.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `user_id` (`integer`, required): ID of the user. Example: 12.

Example input: `{"user_id":12}`

### `zulip_user_update`

Update User · Write

Change a user's full name or role (administrators only).
Returns result success.
Use zulip_user_update to rename a user or change their role.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `user_id` (`integer`, required): ID of the user. Example: 12.
- `full_name` (`string`, optional): New full name. Example: Alex Morgan.
- `role` (`integer`, optional): Role: 100 owner, 200 administrator, 300 moderator, 400 member, 600 guest. Example: 400. One of: `100`, `200`, `300`, `400`, `600`.

Example input: `{"user_id":12}`

### `zulip_channel_archive`

Archive Channel · Destructive

Archive a channel; it becomes read-only and hidden.
Returns result success.
Use zulip_channel_archive for channels no longer in use; unarchive with zulip_channel_update.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `stream_id` (`integer`, required): ID of the channel (get it from zulip_channels_list or zulip_channel_id_get). Example: 15.

Example input: `{"stream_id":15}`

### `zulip_draft_delete`

Delete Draft · Destructive

Delete a draft.
Returns result success.
Use zulip_draft_delete to discard a draft.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `draft_id` (`integer`, required): ID of the draft. Example: 2.

Example input: `{"draft_id":2}`

### `zulip_message_delete`

Delete Message · Destructive

Delete a message permanently.
Returns result success.
Use zulip_message_delete for your own messages or as an admin.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `message_id` (`integer`, required): ID of the message. Example: 43.

Example input: `{"message_id":43}`

### `zulip_message_reaction_remove`

Remove Emoji Reaction · Destructive

Remove your emoji reaction from a message.
Returns result success.
Use zulip_message_reaction_remove to undo a reaction.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `emoji_name` (`string`, required): Emoji name. Example: thumbs_up.
- `message_id` (`integer`, required): ID of the message. Example: 43.
- `emoji_code` (`string`, optional): Emoji code. Example: 1f44d.
- `reaction_type` (`string`, optional): Reaction type. Example: unicode_emoji. One of: `unicode_emoji`, `realm_emoji`, `zulip_extra_emoji`.

Example input: `{"emoji_name":"<emoji_name>","message_id":43}`

### `zulip_reminder_delete`

Delete Reminder · Destructive

Delete a reminder.
Returns result success.
Use zulip_reminder_delete to cancel a reminder.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `reminder_id` (`integer`, required): ID of the reminder. Example: 3.

Example input: `{"reminder_id":3}`

### `zulip_scheduled_message_delete`

Delete Scheduled Message · Destructive

Cancel a scheduled message.
Returns result success.
Use zulip_scheduled_message_delete to stop it from sending.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `scheduled_message_id` (`integer`, required): ID of the scheduled message. Example: 41.

Example input: `{"scheduled_message_id":41}`

### `zulip_subscription_remove`

Unsubscribe from Channels · Destructive

Unsubscribe yourself or other users from channels.
Returns removed and not_removed.
Use zulip_subscription_remove to leave channels.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `subscriptions` (`string`, required): JSON-encoded array of channel names, for example ["release-team"]. Example: ["release-team"]
- `principals` (`string`, optional): JSON-encoded array of user IDs or emails to unsubscribe; defaults to you. Example: [12]

Example input: `{"subscriptions":"<subscriptions>"}`

### `zulip_topic_delete`

Delete Topic · Destructive

Delete a topic and all its messages.
Returns result success and complete (false if it must be called again for large topics).
Use zulip_topic_delete as an admin to remove a topic.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `stream_id` (`integer`, required): ID of the channel (get it from zulip_channels_list or zulip_channel_id_get). Example: 15.
- `topic_name` (`string`, required): Name of the topic to delete. Example: Old planning.

Example input: `{"stream_id":15,"topic_name":"<topic_name>"}`

### `zulip_user_deactivate`

Deactivate User · Destructive

Deactivate a user so they can no longer log in (administrators only).
Returns result success.
Use zulip_user_deactivate for someone who left; undo with zulip_user_reactivate.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`integer`, required): ID of the user. Example: 12.
- `deactivation_notification_comment` (`string`, optional): Comment to email the user about their deactivation. Example: Thanks for your work!.

Example input: `{"user_id":12}`

## Related

Other Communication connectors ([all 132](/agentkit/connectors/?category=communication)):

- [Gmail](/agentkit/connectors/gmail/): Scalekit connector, OAuth, 48 tools
- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Google Calendar](/agentkit/connectors/googlecalendar/): Scalekit connector, OAuth, 30 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
