emergencies

Trigger an emergency from a template

Trigger an emergency using a stored template. Any scope or expiry sent with the request overrides the template's defaults.

Fires a stored template. Scope and expiry given here override the template's defaults. Send {} to use the template as stored.

post/v1/emergencies/from-template/{templateId}

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/emergencies/from-template/{templateId}
  • Auth: HTTP bearer

Path parameters

templateIdstring required

Emergency template id.

Request body

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 1 revision of this API.