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

1.7 KiB

title description aliases menu weight flux/v0.x/tags introduced
teams.endpoint() function The `teams.endpoint()` function sends a message to a Microsoft Teams channel using data from table rows.
/influxdb/v2.0/reference/flux/stdlib/contrib/teams/endpoint/
/influxdb/cloud/reference/flux/stdlib/contrib/teams/endpoint/
flux_0_x_ref
name parent
teams.endpoint teams
202
notification endpoints
0.70.0

The teams.endpoint() function sends a message to a Microsoft Teams channel using data from table rows.

import "contrib/sranka/teams"

teams.endpoint(url: "https://outlook.office.com/webhook/example-webhook")

Parameters

url

Incoming webhook URL.

Usage

teams.endpoint is a factory function that outputs another function. The output function requires a mapFn parameter.

mapFn

A function that builds the object used to generate the POST request. Requires an r parameter.

mapFn accepts a table row (r) and returns an object that must include the following fields:

  • title
  • text
  • summary

For more information, see teams.message() parameters.

Examples

Send critical statuses to a Microsoft Teams channel
import "contrib/sranka/teams"

url = "https://outlook.office.com/webhook/example-webhook"
endpoint = teams.endpoint(url: url)

crit_statuses =
    from(bucket: "example-bucket")
        |> range(start: -1m)
        |> filter(fn: (r) => r._measurement == "statuses" and status == "crit")

crit_statuses
    |> endpoint(
        mapFn: (r) =>
            ({title: "Disk Usage", text: "Disk usage is: **${r.status}**.", summary: "Disk usage is ${r.status}"}),
    )()