Book a demo

List Channels

zulip.get_streams
ActionChat & messagingconnection required

Calls the Zulip API with the connection's credentials.

Read the channels this account can see, so a later step can post to one.

Ask about ZulipAll Zulip nodesProvider API docs ↗

Connection

Required
Yes — the node will not save without one
Auth type
Username & password
Providers
Zulip
Secret shape
{"email": "…", "api_key": "…"} — HTTP Basic, email as the username
Config it needs
base_url
Resolved by
config.connection_id, else node.connection_id

Configuration

4 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
include_public
Include the organization's public channels.
booleanNotrue——
include_subscribed
Include the channels this account is subscribed to.
booleanNotrue——
include_default
Include the channels new members join by default.
booleanNofalse——
exclude_archived
Leave archived channels out of the listing.
booleanNotrue——

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "exclude_archived": true,
  "include_default": false,
  "include_public": true,
  "include_subscribed": true
}

Output

One shape.

result

FieldTypeExample
items
The records Zulip returned.
array—
count
How many records this response carried.
number—
items[].stream_id
The channel id.
number—
items[].name
The channel's name.
string—
items[].description
The channel's description.
string—
items[].rendered_description
The description rendered as HTML.
string—
items[].invite_only
True when the channel is private.
boolean—
items[].is_web_public
True when the channel is readable without an account.
boolean—
items[].is_archived
True when the channel has been archived.
boolean—
items[].date_created
When the channel was created, as a Unix timestamp.
number—
items[].first_message_id
Id of the first message in the channel.
number—
{
  "count": 0,
  "items": [
    {
      "date_created": 0,
      "description": "",
      "first_message_id": 0,
      "invite_only": false,
      "is_archived": false,
      "is_web_public": false,
      "name": "",
      "rendered_description": "",
      "stream_id": 0
    }
  ]
}

Related Zulip nodes

See List Channels run in a workflow.

In a technical demo we add the Zulip connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demoTalk to sales