alert-channels

Send a test Microsoft Teams alert

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.

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

Request body

urlstring required

A Microsoft Teams workflow URL, or the masked URL a saved rule shows (then send ruleId too).

ruleIdstring

With a masked url: the rule whose saved URL to use.

Response

Success.

Changes

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