Skip to content

Subscribers

A subscriber is a notification recipient — a person, role, or system endpoint with one or more contact addresses (email, SMS, webhook).

Quick reference

Method What it does
client.subscribers.list() All subscribers in scope.
client.subscribers.create(name, **fields) Create a subscriber.
client.subscribers.update(uid, **fields) Update fields and addresses.
client.subscribers.delete(uid) Delete.
client.subscribers.list_system_notification_subscribers() Subscribers for system-level alerts (server health, etc.).
client.subscribers.update_system_notifications(*, subscriber_uids, ...) Manage the system-notification recipient list.

Writing

sub = client.subscribers.create(
    name="Ops on-call",
    addresses=[
        {"channel": "email", "value": "oncall@example.com"},
        {"channel": "sms",   "value": "+1-555-0100"},
    ],
)
client.subscribers.update(sub.uid, addresses=[...])

Address shape is deployment-defined — the SDK passes the list through.

System-level subscribers

A second list manages who receives system-level alerts (separate from per-project notification profiles). The dedicated helpers exist because the underlying endpoint is different:

sys_subs = client.subscribers.list_system_notification_subscribers()
client.subscribers.update_system_notifications(
    subscriber_uids=[sub.uid],
)

Model — Subscriber

Field Type Notes
uid str Server-assigned.
name str \| None Display.
addresses list[SubscriberAddresses] Contact channels + values.

SystemSubscriber (returned by list_system_notification_subscribers) has uid, name, plus deployment-specific fields.

Full field list.

See also