Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

herald

Shared notification library for Claude Code plugins.

Overview

Herald was extracted from egregore to provide independent notification capabilities. Any plugin can send alerts through herald without depending on the full egregore orchestrator.

Herald is a pure library plugin: it declares no skills, commands, agents, or hooks. Plugins import its Python API directly (guarded with try/except per ADR-0001).

Installation

/plugin install herald@claude-night-market

Features

  • GitHub issue creation via gh CLI
  • Webhook delivery to Slack, Discord, or generic endpoints
  • SSRF protection with URL validation
  • Configurable source labels for multi-plugin use

Alert Events

EventValueDescription
CRASHcrashProcess or agent crash
RATE_LIMITrate_limitAPI quota exceeded
PIPELINE_FAILUREpipeline_failureBuild or deploy failure
COMPLETIONcompletionTask finished
WATCHDOG_RELAUNCHwatchdog_relaunchWatchdog restarted agent

Usage

from notify import AlertEvent, alert

alert(
    event=AlertEvent.CRASH,
    detail="Worker process crashed",
    source="my-plugin",
)

See the herald README for webhook examples.