OpenBroadcaster Documentation
controllers / alerts.php

Alerts

Controller

Manages alerts, also commonly referred to as emergency broadcasts, priorities, or priority broadcasts.

public  delete ( )

Delete an alert. Requries the 'manage_alerts' permission.

Parameters
id
API Route DELETE /api/v2/alerts/(:id:)
public  get ( )

Return data about a specific alert ID. 'manage_alerts' is a required permission.

Parameters
id
Returns alert
API Route GET /api/v2/alerts/(:id:)
public  save ( )

Save a new alert. The 'user_id' is set to the currently logged in user for the new broadcast. Requires the 'manage_alerts' permission.

Parameters
id ID of alert. Update a pre-existing alert if set.
item_id ID of the media item linked to the alert.
player_id
name
frequency
duration
start
stop
API Route PUT /api/v2/alerts/(:id:)
public  search ( )

Get all alerts for a specific player ID. 'manage_alerts' is a required permission.

Parameters
player_id
Returns alerts
API Route GET /api/v2/alerts/search/(:player_id:)