zulip_channel
diapason.channels.zulip_channel
¶
ZulipChannel — Zulip adapter via zulip Python bindings.
ZulipChannel
¶
Bases: BaseChannel
Zulip messaging channel adapter.
Uses the Zulip API via the official zulip Python package.
Parameters¶
email:
Zulip bot email address. Falls back to ZULIP_EMAIL env var.
api_key:
Zulip bot API key. Falls back to ZULIP_API_KEY env var.
site:
Zulip server URL (e.g. https://yourorg.zulipchat.com).
Falls back to ZULIP_SITE env var.
zuliprc:
Path to a ~/.zuliprc config file. Falls back to ZULIP_RC
env var. If provided, email/api_key/site are ignored.
bus:
Optional event bus for publishing channel events.
connect()
¶
Validate credentials and mark as connected.
disconnect()
¶
Mark as disconnected.
list_channels()
¶
Return available channel identifiers.
on_message(handler)
¶
Register a callback for incoming messages.
send(channel, content, *, conversation_id='', metadata=None)
¶
Send a message to a Zulip stream or user.
Parameters¶
channel: Stream name for stream messages, or email address for direct messages. content: Message content (Markdown supported).
status()
¶
Return the current connection status.