InfluxDB Docs

teams.endpoint() function

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

Function type: Output

import "contrib/sranka/teams"

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

Parameters

url

Incoming webhook URL.

Data type: String

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.

Data type: Function

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().

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}"
    })
  )()

Package author and maintainer

Github: @sranka
InfluxDB Slack: @sranka


New! Cloud or OSS?