Emergencies API

GET/v1/emergencies

List emergency overrides, newest first. Use ?status=active to filter to overrides currently taking over screens.

curl "https://api.brixsignage.com/v1/emergencies" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

{
  "data": [
    {
      "id": "emg_4d5e6f7a8b9c0d1e",
      "spaceId": "space_1a2b3c4d5e6f7a8b",
      "kind": "emergency",
      "status": "active",
      "severity": "critical",
      "headline": "Evacuate the building now",
      "body": "Use the nearest exit. Do not use the lifts.",
      "contentKind": null,
      "contentId": null,
      "scopeKind": "all",
      "scopeNodeId": null,
      "nodeId": null,
      "screenCount": 42,
      "triggeredBy": "usr_5e6f7a8b9c0d1e2f",
      "triggeredAt": "2026-09-28T11:30:00.000Z",
      "expiresAt": null,
      "clearedBy": null,
      "clearedAt": null,
      "triggeredByName": "Sam Rivera",
      "clearedByName": null,
      "scopeName": "All screens",
      "confirmedCount": 0
    }
  ]
}

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/emergencies

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.

Request body application/json

curl -X POST "https://api.brixsignage.com/v1/emergencies" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"headline":"Evacuate the building now","body":"Use the nearest exit. Do not use the lifts.","severity":"critical","scopeKind":"all"}'

Response 201 Success.

{
  "data": {
    "id": "emg_4d5e6f7a8b9c0d1e",
    "spaceId": "space_1a2b3c4d5e6f7a8b",
    "kind": "emergency",
    "status": "active",
    "severity": "critical",
    "headline": "Evacuate the building now",
    "body": "Use the nearest exit. Do not use the lifts.",
    "contentKind": null,
    "contentId": null,
    "scopeKind": "all",
    "scopeNodeId": null,
    "nodeId": null,
    "screenCount": 42,
    "triggeredBy": "usr_5e6f7a8b9c0d1e2f",
    "triggeredAt": "2026-09-28T11:30:00.000Z",
    "expiresAt": null,
    "clearedBy": null,
    "clearedAt": null,
    "triggeredByName": "Sam Rivera",
    "clearedByName": null,
    "scopeName": "All screens",
    "confirmedCount": 0
  }
}

Response 401 Missing, expired or revoked bearer token.

Response 403 `not_shared`: the content is not shared to one or more target locations.

Response 404 The content does not exist in this workspace.

Response 422 Missing headline, a half content pointer, a bad `expiresAt`, no reachable screens (`no_screens`), or content that cannot play (`content_unplayable`).

Response 5XX Server error. The body carries a `requestId` to quote to support.

GET/v1/emergencies/{id}

Retrieve one emergency override, including its scope, content, and expiry.

curl "https://api.brixsignage.com/v1/emergencies/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such emergency in this workspace (or outside your locations).

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/emergencies/{id}/clear

Clear an active emergency override. This releases its screens back to their normal content, and the action is recorded in the activity log.

curl -X POST "https://api.brixsignage.com/v1/emergencies/{id}/clear" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such emergency in this workspace.

Response 409 `already_inactive`: already cleared or expired.

Response 5XX Server error. The body carries a `requestId` to quote to support.

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

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.

Request body application/json

curl -X POST "https://api.brixsignage.com/v1/emergencies/from-template/{templateId}" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 201 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 `not_shared`: the template's content is not shared to one or more target locations.

Response 404 No such template, or its content is gone.

Response 422 Bad `expiresAt`, no reachable screens (`no_screens`), or content that cannot play.

Response 5XX Server error. The body carries a `requestId` to quote to support.