> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/zulip.md).

# Zulip

Connect to Zulip to send and read channel and direct messages, create channels, react to messages, and manage subscriptions.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Zulip     | API Key        |

### Zulip

Connect to Zulip to send messages, manage channels, and react to messages.

#### Set up in Zulip

1. Prepare the Zulip account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Prefer a bot's API key: in Zulip, go to Personal settings > Bots, add a bot, then copy its API key. A bot's key only reaches what the bot itself can see (and it must be subscribed to a channel to read its messages), so it is the least-privilege option. A personal API key works with the same steps under Personal settings > Account & privacy, but it exposes StackAI to your entire account, including private channels and direct messages, since Zulip has no scopes to narrow it. Prefer a bot key unless you specifically need to act as yourself.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Zulip**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field  | Required | What to enter                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Zulip Site URL | Yes      | Your Zulip organization's URL. Zulip Cloud is 'https\://\<organization>.zulipchat.com'; self-hosted is your server's HTTPS URL. Do not include /api or any path.                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Account Email  | Yes      | The email bound to the API key below: a bot's email, or your own account email.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| API Key        | Yes      | Prefer a bot's API key: in Zulip, go to Personal settings > Bots, add a bot, then copy its API key. A bot's key only reaches what the bot itself can see (and it must be subscribed to a channel to read its messages), so it is the least-privilege option. A personal API key works with the same steps under Personal settings > Account & privacy, but it exposes StackAI to your entire account, including private channels and direct messages, since Zulip has no scopes to narrow it. Prefer a bot key unless you specifically need to act as yourself. [Provider instructions](https://zulip.com/api/api-keys). |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Zulip** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Send Message

Post a message to a Zulip channel topic, or send a direct message to one or more people.

#### Inputs

| Field          | Type            | Required | Description                                                                                                                                                         |
| -------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Send to        | select (string) | Yes      | Whether this goes to a channel topic or straight to people as a direct message. Available values: Channel, Direct Message. Default: channel.                        |
| Channel        | select (string) | No       | The channel to post in. Only used for channel messages. Options load from the selected connection.                                                                  |
| Topic          | select (string) | No       | The conversation topic within the channel. Reuse an existing topic to continue a thread, or type a new one to start one. Options load from the selected connection. |
| Recipients     | string          | No       | Email addresses of the people to direct-message, separated by commas.                                                                                               |
| Message        | textarea        | Yes      | The message text. Zulip Markdown is supported, including **bold**, lists, and code blocks.                                                                          |
| Attachment URL | string          | No       | A file to attach. Give a public URL and StackAI uploads it to Zulip for you.                                                                                        |

#### Outputs

| Field          | Type    | Description                                                            |
| -------------- | ------- | ---------------------------------------------------------------------- |
| Message ID     | integer | The id Zulip assigned to this message.                                 |
| Channel        | string  | The channel involved, blank for a direct message.                      |
| Topic          | string  | The conversation topic, blank for a direct message.                    |
| Attachment URL | string  | Zulip-hosted link to the attachment, when one was uploaded.            |
| Message link   | string  | A direct link to the message you just posted.                          |
| Markdown link  | string  | A ready-to-paste Markdown link to the message within its conversation. |

### List Messages

Read recent messages from a channel, a topic, or a search across the organization. If connected with a bot's API key, an empty result can mean the bot is not subscribed to the channel rather than the channel having no messages. Use Add People to Channel with the bot's own email to subscribe it first.

#### Inputs

| Field            | Type            | Required | Description                                                                                                                    |
| ---------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Channel          | select (string) | No       | Limit results to one channel. Leave blank to search everywhere the account can see. Options load from the selected connection. |
| Topic            | select (string) | No       | Limit results to one topic within the channel. Options load from the selected connection.                                      |
| Search text      | string          | No       | Only return messages containing these words.                                                                                   |
| Sender           | select (string) | No       | Only return messages from this person. Options load from the selected connection.                                              |
| Maximum messages | integer         | No       | How many messages to return at most. Default: 50.                                                                              |
| Cursor           | string          | No       | Continue from where a previous run stopped.                                                                                    |

#### Outputs

| Field          | Type          | Description                                       |
| -------------- | ------------- | ------------------------------------------------- |
| Messages       | object\_array | The messages that matched, oldest first.          |
| Next cursor    | string        | Pass this back in to read further.                |
| Reached newest | boolean       | Whether the newest matching message was included. |

### Create Channel

Create a new Zulip channel, optionally private and with people already subscribed.

#### Inputs

| Field           | Type            | Required | Description                                                                                                    |
| --------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| Channel name    | string          | Yes      | Name for the new channel, as people will see it in the sidebar.                                                |
| Description     | textarea        | No       | A short line explaining what the channel is for.                                                               |
| Make it private | boolean         | No       | Private channels are visible only to people who are invited.                                                   |
| Subscribers     | select (string) | No       | People to add to the channel right away, as comma-separated emails. Options load from the selected connection. |
| Announce it     | boolean         | No       | Post a notice about the new channel so people know it exists.                                                  |

#### Outputs

| Field      | Type    | Description                                |
| ---------- | ------- | ------------------------------------------ |
| Channel ID | integer | The id Zulip assigned to the channel.      |
| Name       | string  | The channel's name.                        |
| Private    | boolean | Whether the channel was created private.   |
| Not found  | string  | Emails that did not match a Zulip account. |

### Add Reaction

React to a message with an emoji.

#### Inputs

| Field      | Type    | Required | Description                                      |
| ---------- | ------- | -------- | ------------------------------------------------ |
| Message ID | integer | Yes      | The message to react to.                         |
| Emoji      | string  | Yes      | Name of the emoji to react with, without colons. |

#### Outputs

| Field      | Type    | Description                      |
| ---------- | ------- | -------------------------------- |
| Message ID | integer | The message that was reacted to. |
| Emoji      | string  | The emoji that was added.        |

### Remove Reaction

Take back an emoji reaction on a message.

#### Inputs

| Field      | Type    | Required | Description                                           |
| ---------- | ------- | -------- | ----------------------------------------------------- |
| Message ID | integer | Yes      | The message to remove your reaction from.             |
| Emoji      | string  | Yes      | Name of the emoji reaction to remove, without colons. |

#### Outputs

| Field      | Type    | Description                                          |
| ---------- | ------- | ---------------------------------------------------- |
| Message ID | integer | The id of the message the reaction was removed from. |
| Emoji      | string  | The emoji involved.                                  |

### Update Message

Edit a message's text, rename its topic, or move it to another channel or topic.

#### Inputs

| Field           | Type            | Required | Description                                                                                                                                                                                                                          |
| --------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Message ID      | integer         | Yes      | The message to edit or move.                                                                                                                                                                                                         |
| New message     | textarea        | No       | Replacement text for the message. Omit to keep the current text. Zulip cannot change the text and move the message in one step.                                                                                                      |
| New topic       | string          | No       | Rename the conversation, or move this message to a different topic.                                                                                                                                                                  |
| Move to channel | select (string) | No       | Move the message into a different channel. Options load from the selected connection.                                                                                                                                                |
| Apply to        | select (string) | No       | Whether the topic or channel change affects only this message, this message and later ones, or the entire conversation. Available values: Just this message, This and later messages, The entire conversation. Default: change\_one. |

#### Outputs

| Field          | Type    | Description                            |
| -------------- | ------- | -------------------------------------- |
| Message ID     | integer | The id Zulip assigned to this message. |
| Updated fields | string  | Which parts of the message changed.    |

### List Channels

List the channels the connected account can see, with their ids and descriptions.

#### Inputs

| Field                       | Type    | Required | Description                                                              |
| --------------------------- | ------- | -------- | ------------------------------------------------------------------------ |
| Include public channels     | boolean | No       | Include public channels the account is not subscribed to. Default: true. |
| Include subscribed channels | boolean | No       | Include channels the account is subscribed to. Default: true.            |

#### Outputs

| Field    | Type          | Description                   |
| -------- | ------------- | ----------------------------- |
| Channels | object\_array | The channels that were found. |

### List Channel Topics

List the recent conversation topics in a channel, newest first, so you know which topic to continue instead of starting a new one. If connected with a bot's API key, only channels the bot is subscribed to are visible; use Add People to Channel with the bot's own email to subscribe it first.

#### Inputs

| Field   | Type            | Required | Description                                                                          |
| ------- | --------------- | -------- | ------------------------------------------------------------------------------------ |
| Channel | select (string) | Yes      | The channel whose topics you want to see. Options load from the selected connection. |

#### Outputs

| Field  | Type          | Description                                          |
| ------ | ------------- | ---------------------------------------------------- |
| Topics | object\_array | The recent topics in the channel, most recent first. |

### Add People to Channel

Subscribe one or more people to an existing channel.

#### Inputs

| Field   | Type            | Required | Description                                                                       |
| ------- | --------------- | -------- | --------------------------------------------------------------------------------- |
| Channel | select (string) | Yes      | The existing channel to add people to. Options load from the selected connection. |
| People  | string          | Yes      | Email addresses of the people to subscribe, separated by commas.                  |

#### Outputs

| Field              | Type   | Description                                |
| ------------------ | ------ | ------------------------------------------ |
| Channel            | string | The channel people were added to.          |
| Subscribed         | string | People newly added to the channel.         |
| Already subscribed | string | People who were already in the channel.    |
| Not found          | string | Emails that did not match a Zulip account. |

### Upload File

Upload a file to Zulip and get a link you can put in a message.

#### Inputs

| Field     | Type   | Required | Description                                                    |
| --------- | ------ | -------- | -------------------------------------------------------------- |
| File URL  | string | Yes      | Public link to the file you want to upload.                    |
| File name | string | No       | Name to store the file under. Defaults to the name in the URL. |

#### Outputs

| Field         | Type   | Description                                 |
| ------------- | ------ | ------------------------------------------- |
| File URL      | string | The Zulip-hosted link to the uploaded file. |
| Markdown link | string | A ready-to-paste Markdown link to the file. |
| File name     | string | The name the file was stored under.         |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### New Message

Starts a flow when a new message arrives, optionally limited to one channel or topic.

If connected with a bot's API key, the bot must be subscribed to a channel to see its messages: run Add People to Channel with the bot's own email. Leave channel and topic blank to watch every channel the account can see.

#### Configuration

| Field       | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                          |
| ----------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Channel     | select (string) | No       | Only trigger on messages in this channel. Leave blank to watch everything the account can see. If connected with a bot's API key, an empty result can mean the bot is not subscribed to the channel rather than the channel having no messages. Use Add People to Channel with the bot's own email to subscribe it first. Options load from the selected connection. |
| Topic       | select (string) | No       | Only trigger on messages in this topic. Options load from the selected connection.                                                                                                                                                                                                                                                                                   |
| Search text | string          | No       | Only trigger on messages containing these words.                                                                                                                                                                                                                                                                                                                     |

#### Event inputs

| Field        | Type     | Required | Description                                                    |
| ------------ | -------- | -------- | -------------------------------------------------------------- |
| Message ID   | integer  | Yes      | The id Zulip assigned to this message.                         |
| Sender email | string   | Yes      | Email of the person who sent the message.                      |
| Sender name  | string   | Yes      | Display name of the person who sent the message.               |
| Channel      | string   | No       | The channel involved, blank for a direct message. Default: .   |
| Topic        | string   | No       | The conversation topic, blank for a direct message. Default: . |
| Message      | textarea | Yes      | The message text.                                              |
| Sent at      | datetime | Yes      | When the message was sent.                                     |

#### Outputs

| Field        | Type     | Description                                         |
| ------------ | -------- | --------------------------------------------------- |
| Message ID   | integer  | The id Zulip assigned to this message.              |
| Sender email | string   | Email of the person who sent the message.           |
| Sender name  | string   | Display name of the person who sent the message.    |
| Channel      | string   | The channel involved, blank for a direct message.   |
| Topic        | string   | The conversation topic, blank for a direct message. |
| Message      | textarea | The message text.                                   |
| Sent at      | datetime | When the message was sent.                          |

### New Direct Message

Starts a flow when the connected account receives a direct message, optionally limited to one sender.

With a bot's API key, this watches direct messages sent to the bot itself, not any other user's messages. With a personal account's API key, it watches that person's own direct messages. Leave sender blank to watch every sender.

#### Configuration

| Field | Type            | Required | Description                                                                                                          |
| ----- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
| From  | select (string) | No       | Only trigger on direct messages from this person. Leave blank for anyone. Options load from the selected connection. |

#### Event inputs

| Field        | Type     | Required | Description                                      |
| ------------ | -------- | -------- | ------------------------------------------------ |
| Message ID   | integer  | Yes      | The id Zulip assigned to this message.           |
| Sender email | string   | Yes      | Email of the person who sent the message.        |
| Sender name  | string   | Yes      | Display name of the person who sent the message. |
| Message      | textarea | Yes      | The message text.                                |
| Sent at      | datetime | Yes      | When the message was sent.                       |

#### Outputs

| Field        | Type     | Description                                      |
| ------------ | -------- | ------------------------------------------------ |
| Message ID   | integer  | The id Zulip assigned to this message.           |
| Sender email | string   | Email of the person who sent the message.        |
| Sender name  | string   | Display name of the person who sent the message. |
| Message      | textarea | The message text.                                |
| Sent at      | datetime | When the message was sent.                       |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/zulip.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
