Notifications

A notification profile is a rule the server applies to fire alerts (SMS / email / webhook) when matching events occur. Profiles bind to event types and target Subscribers.

Quick reference

Method	What it does
client.notifications.list()	All notification profiles in scope.
client.notifications.list_types()	The catalog of NotificationType (server-defined event taxonomies).
client.notifications.create(name, **fields)	Create a profile.
client.notifications.update(uid, **fields)	Update fields.
client.notifications.delete(uid)	Delete a profile.

Reading and writing

types = client.notifications.list_types()
profile = client.notifications.create(
    name="fall-alerts",
    notification_type_uid=types[0].uid,
    subscriber_uids=[sub.uid],
)
client.notifications.update(profile.uid, enabled=False)
client.notifications.delete(profile.uid)

The exact set of fields varies by deployment; the SDK passes them through unchanged. See notifications.list_types() to discover what your deployment supports.

Model — NotificationProfile

Field	Type	Notes
uid	str	Server-assigned.
name	str \| None	Display.
notification_type_uid	str \| None	Foreign key to the type catalog.
subscriber_uids	list[str]	Recipients.
enabled	bool \| None	Lifecycle.

NotificationType (returned by list_types) has uid, name, and deployment-defined extras.

Full field list.

Related entities

• Subscribers: Subscribers are the recipients referenced by subscriber_uids.

See also

• Subscribers — how to manage recipients and their addresses.