Skip to main content
Alerts connect events to delivery channels. Use a callback URL for server-to-server notifications, and optionally attach a WebSocket for real-time dashboards.

Quick Example


Delivery Methods

You can use both simultaneously for redundancy. Alert creation requires a callback URL even when a WebSocket connection is attached. Replace https://example.com in the examples with a reachable endpoint you control.

Webhook Delivery

Create Webhook Alert

Illustrative Callback Payload

Callback payload fields can vary by pipeline and backend. Inspect and validate the payload your endpoint receives before relying on individual fields:

Possible Payload Fields


WebSocket Delivery

Connect and Listen

WebSocket Channels

The current V2 alert channel is produced by the V2 scene index: The following channel names are available through RTStream helper APIs:

Managing Alerts

List Alerts

Enable/Disable Alerts

Dual Delivery Pattern

Use both channels for critical alerts:
Benefits:
  • WebSocket delivers instantly to connected clients
  • Webhook provides reliable server-side processing
  • If WebSocket disconnects, webhook still works

Latency Profile


Delivery Guarantees


Next Steps

Webhooks and Reliability

Handle webhooks at scale with idempotency

Event Detection Patterns

Create effective detection rules