docs-v2/content/flux/v0/stdlib/contrib/sranka/teams/message.md

2.3 KiB

title description menu weight flux/v0/tags
teams.message() function `teams.message()` sends a single message to a Microsoft Teams channel using an [incoming webhook](https://docs.microsoft.com/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook).
flux_v0_ref
name parent identifier
teams.message contrib/sranka/teams contrib/sranka/teams/message
301
single notification

teams.message() sends a single message to a Microsoft Teams channel using an incoming webhook.

Function type signature
(text: string, title: A, url: string, ?summary: string) => int

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

url

({{< req >}}) Incoming webhook URL.

title

({{< req >}}) Message card title.

text

({{< req >}}) Message card text.

summary

Message card summary. Default is "".

If no summary is provided, Flux generates the summary from the message text.

Examples

Send the last reported status to a Microsoft Teams channel

import "contrib/sranka/teams"

lastReported =
    from(bucket: "example-bucket")
        |> range(start: -1m)
        |> filter(fn: (r) => r._measurement == "statuses")
        |> last()
        |> findRecord(fn: (key) => true, idx: 0)

teams.message(
    url: "https://outlook.office.com/webhook/example-webhook",
    title: "Disk Usage",
    text: "Disk usage is: *${lastReported.status}*.",
    summary: "Disk usage is ${lastReported.status}",
)