Alert channels API
Alert channels endpoints in the Brix REST API for digital signage: 1 operation (POST). Each lists its path, auth, required permission and a curl example.
View as Markdown · For AI agents: the full docs index is at /llms.txt
Base URL https://api.brixsignage.com. Send Authorization: Bearer $BRIX_API_KEY unless an operation says Auth: none or Auth: no API key. The Permission line names what the key must hold. See Authentication and scopes, Errors and rate limits and Pagination.
Every 4xx and 5xx response below returns this body:
| Field | Type | Description |
|---|---|---|
error | string | Machine-readable code: unauthorized, forbidden, not_found, validation_error, conflict, rate_limited, internal_error, … |
message | string | Human-readable explanation. Safe to show an operator. |
requestId | string | Present on 5xx: quote it to support. |
POST /v1/alert-channels/teams/test
Send a sample alert card to a Microsoft Teams webhook to confirm it is configured correctly. Provide the webhook url in the request body; it must be a Microsoft Teams Workflow URL. The response returns ok, status, and an optional message, and never includes the URL you sent. This operation is rate-limited to 10 requests per minute.
A refusal from Microsoft Teams is NOT an HTTP error: the answer is 200 with ok: false and a message to show.
Request body: application/json
| Field | Type | Required | Description |
|---|---|---|---|
url | string | yes | A Microsoft Teams workflow URL, or the masked URL a saved rule shows (then send ruleId too). |
ruleId | string | no | With a masked url: the rule whose saved URL to use. |
curl -X POST "https://api.brixsignage.com/v1/alert-channels/teams/test" \
-H "Authorization: Bearer $BRIX_API_KEY" \
-H "Content-Type: application/json"Response 200: Success.
| Field | Type | Description |
|---|---|---|
data | object | object |
Response 401: Missing, expired or revoked bearer token.
Response 403: The token lacks the permission this operation needs (see x-brix-permission).
Response 422: The URL is not a Microsoft Teams workflow URL, or a masked URL matches no URL saved on ruleId.
Response 429: More than 10 calls in a minute.
Response 5XX: Server error. The body carries a requestId to quote to support.