alert-rules

Create an alert rule

Create an alert rule with a name, trigger, optional config, optional enabled flag, and optional nodeId. If the scope named in config does not resolve to an existing target, the request is refused rather than saved. A Microsoft Teams channel is also refused unless config.teamsUrls contains at least one valid Microsoft Teams Workflow HTTPS URL. The response shows each URL masked.

Notes.

  • The 201 body is the row as written, not re-read: nodeId is absent when the create did not set one.
post/v1/alert-rules

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/alert-rules
  • Auth: HTTP bearer

Request body

namestring required
triggerstring required
enabledboolean
nodeIdstring nullable

Response

Success.

Example response

{
  "data": {
    "id": "alr_4d5e6f7a8b9c0d1e"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.