Create Notification Rule

Creates a notification rule. Recipients are determined by user_group_ids (an empty list resolves to the default "all members" group). Optional entity_filters narrow delivery to specific gateways, cameras, streams, deployments, pipelines, or tags. Optional title_keywords further filter analytics events by case-insensitive substring match against the event title.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The application this notification rule belongs to.

Body Params
string
required
notification_categories
array of objects
required
notification_categories*
Allowed:
notification_types
array of objects | null
Defaults to null
notification_types
entity_filters
object | null

If include is set, entities must match at least one criterion. If exclude is set, matching entities are filtered out (overrides include).

title_keywords
array of strings
Defaults to []
title_keywords
user_group_ids
array of uuids
required
user_group_ids*
string
enum
Defaults to immediate

Delivery cadence for a notification rule.

Only immediate is currently accepted by the public API; the digest pipeline is not implemented yet and create/update reject digest_hourly and digest_daily with unsupported-notification-frequency (400).

Allowed:
Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json