Skip to main content

Cue

Self-hosted notification decision engine: quiet hours, time zones, digests, frequency caps and preferences in front of the sender you already have.

CI Python License: MIT

Documentation · Getting started · Architecture


Your backend reports what happened (order.shipped, payment.failed). Cue decides whether that is worth a notification, renders it in the person's language, picks the time and the route, and hands a finished message to the delivery you connect: your own sending service through a signed webhook, or a bundled connector.

  • Rules and policy in one place. JSON Logic rules map events to templates; every message, whether triggered by a rule, sent directly or broadcast, passes the same checks: unsubscribes, muted channels, frequency caps, cooldowns and quiet hours in the recipient's own time zone, checked again right before sending.
  • Fewer messages. Digests turn a burst of events into one message per window or one per day at a local time, and fatigue backs off from people who stopped engaging.
  • People in control. A hosted preference page (or a JSON API for your own), RFC 8058 one-click unsubscribe, and a consent ledger of every change.
  • Answers. Every event records which rules matched and why; every message records its status and the reason it was suppressed or failed.
  • Limits for automated senders. Agents and other services get per-person budgets, importance ceilings and human approval before anything goes out.
curl -X POST https://cue.example.com/v1/events \
  -H "Authorization: Bearer $CUE_API_KEY" -H "Content-Type: application/json" \
  -d '{"name": "order.shipped", "recipient": "customer-42",
       "data": {"order_id": "1001"}, "idempotency_key": "order-1001-shipped"}'

Your delivery endpoint then receives a signed, fully rendered message:

{
  "id": "01a1…",
  "channel": "push",
  "address": "<device token>",
  "locale": "en",
  "importance": "normal",
  "expires_at": null,
  "content": {"title": "Your order is on its way", "body": "Order 1001 ships today.",
              "url": "https://shop.example/orders/1001"},
  "metadata": {"cue_message_id": "01a1…", "cue_tracking_token": "…"},
  "links": {"preferences": "https://cue.example.com/preferences/…"}
}

Who it's for

For teams that already send push, e-mail, SMS or chat messages from their own code and want the decisions (whether, when, how often, over which route, in which language) made in one place, stored, and explainable, on their own infrastructure.

Not for you (yet) if you need:

  • an in-app inbox or notification feed: planned, not built;
  • an admin UI: today you configure Cue through the HTTP API, the CLI and cue.toml;
  • APNs, Amazon SES, Resend or Slack connectors: planned. Today's connectors are FCM, Twilio, SMTP, Telegram, a signed webhook and console, plus any you write;
  • a hosted service: Cue is self-hosted only;
  • a visual journey builder for marketing campaigns: not planned.

See the roadmap.

Quick start

With Docker Compose (PostgreSQL, an API and a worker; messages go to the worker's log):

git clone https://github.com/murtazox04/Cue && cd Cue
docker compose up --build -d
docker compose exec api cuectl keys create admin
docker compose logs -f worker

Or with Python 3.12+ and SQLite, in a virtual environment:

python -m venv .venv && . .venv/bin/activate
pip install cue-notify
export CUE_WORKER__EMBEDDED=true
export CUE_CHANNELS__PUSH__PROVIDER=console CUE_CHANNELS__SMS__PROVIDER=console
cuectl db upgrade && cuectl keys create admin && cuectl serve

keys create prints an API key once; keep it as CUE_API_KEY. Then follow the getting-started guide to create a template and a rule and send an event that shows up in the log.

To try it without installing anything, with uv:

CUE_WORKER__EMBEDDED=true CUE_CHANNELS__PUSH__PROVIDER=console \
  CUE_CHANNELS__SMS__PROVIDER=console uvx cue-notify serve --migrate

and, in a second terminal in the same directory (both use ./cue.db), uvx cue-notify keys create admin.

Bring your own delivery

Each route (push, sms, email, ops-alerts…) is backed by a connector:

Connector Use it when
webhook You already have a sending service, or want full control. Cue POSTs signed JSON to it.
fcm, twilio, smtp, telegram You want a ready-made connector for these providers.
console Local development: messages are logged.
your own Write a small class and register it as a plugin; see custom connectors.

Connectors are configuration, not code changes: swap SMS vendors without touching a rule.

AI agents and other automated senders

  • Agents as senders. Each agent gets its own key with a per-person attention budget, an importance ceiling and, where you want it, human approval before anything goes out. Agent keys cannot read or change people's profiles, and cannot approve anything. See agents.
  • Ask a person first. Before a risky action (a refund, a deletion, a mass e-mail), an agent calls POST /v1/approvals or the request_approval MCP tool. Cue tells the reviewers on their own channels with a one-time link and reports the decision back, with bridges for LangGraph, Pydantic AI, CrewAI Flows and Dapr Agents. See approval requests.
  • MCP server. uvx cue-notify mcp gives Claude, Cursor or your own agent tools to notify people and inspect delivery, under the same policy and audit trail. See AI agents (MCP).
  • Screening (optional, off by default, experimental). With [screening] enabled = true and a TypeSafe API key, a decision model (Jev) reads each agent message before it is sent: pressure, deception or leaked secrets hold it for a person, and overstated importance is lowered. Built against TypeSafe's published API; not yet proven in production. Your own backend's messages are never screened.
  • Coding agents. cue-hook lets OpenHands and Claude Code tell you when they finish or wait for input. See coding agents.
  • Claude Code plugin. /plugin marketplace add murtazox04/Cue, then /plugin install cue@cue, adds a skill for integrating Cue into an application.

Also

  • SDKs. pip install cue-notify-client and npm install cue-client, both with webhook signature verification. See SDKs.
  • Engagement tracking. Delivered, opened, clicked, converted; client apps report with a per-message token, no API key needed.
  • Broadcasts. Audience filters, resumable batches, pause/resume/cancel without double sends.
  • Compliance. US texting hours and state caps for marketing texts, STOP/START replies, and opt-in records with the disclosure shown. See compliance.
  • Runs on your database. An API process and a worker process (or the worker embedded in the API for small installs), with PostgreSQL or SQLite. No Redis or message broker: the durable job queue lives in the database. Schedule cuectl prune yourself for retention.
  • Observable. Per-rule event outcomes, status reasons, Prometheus metrics, JSON logs.
  • Docs for tools. llms.txt and AGENTS.md.

How Cue compares

What it is Difference from Cue
Novu Notification infrastructure you can self-host. Its self-hosting guide lists MongoDB, Redis and S3-compatible storage. Cue needs one database, PostgreSQL or SQLite.
Knock, Courier, OneSignal Hosted notification services. You sign up for their service; Cue runs on your infrastructure.
Apprise, ntfy Tools that deliver a message to many services or devices. They send what you hand them; whether and when a person should be notified (preferences, caps, quiet hours in their time zone, digests) is left to your code. Cue makes that decision, then hands the message to a sender.
Framework notification libraries (Laravel, Rails, Django…) Code in your application that formats and sends notifications. Policy, preferences and history are yours to build per application; Cue keeps them in one service that every application and agent calls.

How it works

flowchart LR
    E[POST /v1/events] --> R{Rules}
    R --> P[Policy<br/>unsubscribe · caps · cooldown · quiet hours]
    P --> T[Template<br/>locale · route variants]
    T --> Q[(Queue)]
    Q --> A[AI rewording<br/>optional]
    A --> C{Your delivery<br/>webhook · connectors}
Concept In one line
Event Something that happened to a recipient. Idempotent, stored with per-rule outcomes.
Rule When event X (and condition) → send template Y over routes [A, B].
Template Localised content with route-specific variants.
Category Policy bundle: frequency caps, quiet hours, whether unsubscribing is allowed.
Channel A named route (push, sms…) backed by a connector.
Message One notification to one recipient, with a full status trail.
Broadcast One template to an audience, in resumable batches.

Configuration

Environment variables (CUE_SECTION__KEY) or a cue.toml:

[database]
url = "postgresql+asyncpg://cue:secret@db/cue"

[api]
public_url = "https://cue.example.com"   # needs CUE_API__SECRET_KEY

[channels.push]
provider = "webhook"
url = "https://notifications.internal.example/push"   # secret from CUE_CHANNELS__PUSH__SECRET

[channels.sms]
provider = "twilio"
account_sid = "AC…"
from_number = "+15550100"   # auth token from CUE_CHANNELS__SMS__AUTH_TOKEN

See the configuration reference, deployment and examples/cue.toml.

Project status

Cue is in early development (0.x): the model and API are stable in shape but may still change before 1.0; each release's changelog says what to do when upgrading. See the roadmap for what comes next. Feedback and contributions are welcome; see CONTRIBUTING.md.

License

MIT

Metadata

Release files for cue-notify 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cue-notify 0.4.0
File Size Uploaded
cue_notify-0.4.0.tar.gz 213.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cue-notify 0.4.0
File Interpreter ABI Platform
cue_notify-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 398.7 kB

Release files / cue_notify-0.4.0.tar.gz

Download URL cue_notify-0.4.0.tar.gz
Size 213.6 kB
Tags Source
SHA-256 checksum
How to use checksums
b1a6148d788a22f058cd169100df29814c08ee9b1443aa2cb32936a068902562
BLAKE2b-256 checksum
How to use checksums
3c31201094bd6b87a617d8101db122b8fa175cf7ad5c5c925f8c54518ef2d5b9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 12, 2026.

Transparency log

Release files / cue_notify-0.4.0-py3-none-any.whl

Download URL cue_notify-0.4.0-py3-none-any.whl
Size 185.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1bbd1bab3c18916367a68ce10dc06a3da001b1b3a45b4332e83d332e8d88e38e
BLAKE2b-256 checksum
How to use checksums
b8a11621c24bd00fa9c8a6e76895531a30977dce26816a9a7fee7ae521dc231d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 12, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page