Skip to main content
POST
Create RTStream alert
Create an alert that triggers when a detection event matches on a stream’s scene index. Alerts can send webhooks or WebSocket notifications.
  • event_id is required - must reference an existing detection event
  • Use callback_url for HTTP webhook notifications when the event is detected
  • Use ws_connection_id for real-time WebSocket notifications
  • Alerts are created in enabled status by default

Create Event

Define a detection event first

Alerts Guide

Learn about alerts and callbacks

Authorizations

x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

stream_id
string
required
Example:

"rts-12345"

scene_index_id
string
required
Example:

"scene-idx-12345"

Body

application/json
event_id
string
required
Example:

"event-12345"

callback_url
string
Example:

"https://webhook.example.com/alert"

ws_connection_id
string
Example:

"conn-123"

Response

200 - application/json

Alert created

success
boolean
Example:

true

data
object