emergencies

Trigger an emergency takeover

Trigger an emergency takeover across a set of screens. An emergency takes the highest priority and layers over each screen's normal content, so clearing it restores exactly what was playing before.

Takes over the chosen screens now, above every schedule and cast, until cleared or expired. Clearing restores exactly what was playing.

Notes.

  • The route is gated by emergency-override.create; the route registry's description names emergency-override.trigger, which is not a permission the API checks.
post/v1/emergencies

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/emergencies
  • Auth: HTTP bearer

Request body

headlinestring required

The message on every targeted screen. Required, non-blank.

bodystring

Optional second line.

severity'info' | 'warning' | 'critical'

Default critical.

contentKind'media' | 'creative'

Attach content to show under the banner. Needs contentId.

contentIdstring

The media or creative id. Needs contentKind.

scopeKind'all' | 'node' | 'screens'

Which screens: every screen you can reach (all), one location's subtree (node), or a list (screens). Defaults to all: omit it and the emergency goes to EVERY screen you can reach.

scopeNodeIdstring

Location id, with scopeKind: node.

screenIdsstring[]

Screen ids, with scopeKind: screens.

Response

Success.

Example response

{
  "data": {
    "id": "cast_9f2c4a1b7d3e5f60"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.