Threaded team chat. Bot API to your stream/topic.
Where to get it
A Zulip organization (self-hosted or cloud) + a bot's email/API key and stream/topic.
Install / what you need
No install — create a bot in your Zulip org and copy its API key.
How to connect
- 1 Create a bot in your Zulip organization and copy its email + API key.
- 2 Dashboard → Notifications → Add destination → zulip, set the org URL, bot key, stream, topic.
- 3 Send test.
When you'd use it
What Herald sends through this channel
6 setup fields
Herald hands every alert to the
ZulipAdapter
as a DispatchPlan. The fields
below are what the dashboard form asks for; the sample is the plan the adapter receives.
The adapter renders it into the channel-native shape (Discord embeds, Teams MessageCards,
PagerDuty Events-API payloads, TwiML, JSON POST bodies) on the way out — that wire transcript varies per channel.
Setup form fields
| field | type | required | description / default |
|---|---|---|---|
| server_url | string | required | Zulip server base URL (self-host, or https://<org>.zulipchat.com) |
| bot_email | string | required | Zulip bot email (Settings → Bots → Add a bot) |
| api_key | string | required | The bot's API key |
| stream | string | required | Target stream (channel) name |
| topic | string | optional | Topic within the stream · default: "CyberCLI" |
| timeout_seconds | number | optional | no description · default: 10 |
Sample DispatchPlan (input to the adapter)
{
"decision_id": "tdc-2026-06-20-abc12",
"channel": "<channel-type>",
"recipient": {
"recipient_id": "soc-oncall",
"display_name": "SOC on-call",
"addresses": [
{
"channel": "<channel-type>",
"address": "<destination>",
"min_defcon": 5
}
]
},
"urgency": "high",
"retry_policy": {
"max_attempts": 3,
"initial_backoff_seconds": 5
},
"subject": "Suspicious login on CEO-LAPTOP",
"body": "Warden flagged a PowerShell child of WINWORD.EXE. The encoded command resolved to a base64-wrapped Invoke-WebRequest to a newly-registered domain. Trust ladder: L3.",
"approval_link": "https://app.cybercli.local/approve/abc12",
"incident_ref": "case-2026-0142",
"signal_id": "sig-2026-06-20-9f3"
} Sovereignty: byo_external · Min tier (BYO): free · Threaded team chat; self-hostable (Free+). LOCAL when self-hosted.
Self-host Zulip to keep it local; the bot API key is the only secret, vault-stored.
Herald — the Guild's voice role — routes alerts, daily digests, and AI verdicts here, on a per-CYCON-state matrix you control. CYCON 1/2 alerts repeat until an operator acks.
The Guild →