---
title: "Send a test Microsoft Teams alert"
method: POST
path: "/v1/alert-channels/teams/test"
tags: ["alert-channels"]
---

# Send a test Microsoft Teams alert

`POST /v1/alert-channels/teams/test`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/alert-channels/teams/test`
- Auth: HTTP bearer

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

- object
  - `url` string, required: A Microsoft Teams workflow URL, or the masked URL a saved rule shows (then send `ruleId` too).
  - `ruleId` string: With a masked `url`: the rule whose saved URL to use.

## Response `200`

Success.

- object
  - `data` union, required
    - object
      - `ok` false, required
      - `status` integer, required: HTTP status Microsoft Teams answered with; 0 when it did not answer.
      - `message` string, required: What went wrong, in words to show an operator.
    - object
      - `ok` true, required
      - `status` integer, required

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `422`: The URL is not a Microsoft Teams workflow URL, or a masked URL matches no URL saved on `ruleId`.
- `429`: More than 10 calls in a minute.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)