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

title	description	menu	weight	aliases	flux/v0.x/tags
webexteams.endpoint() function	The `webexteams.endpoint()` function sends a single message to Webex using the [Webex messages API](https://developer.webex.com/docs/api/v1/messages/create-a-message).	flux_0_x_ref name parent webexteams.endpoint webexteams	202	/influxdb/v2.0/reference/flux/stdlib/contrib/webexteams/endpoint/ /influxdb/cloud/reference/flux/stdlib/contrib/webexteams/endpoint/	notification endpoints

The webexteams.endpoint() function returns a function that sends a message that includes data from input rows to a Webex room.

import "contrib/sranka/webexteams"

webexteams.endpoint(
    url: "https://webexapis.com",
    token: "token",
)

Parameters

url

Base URL of Webex API endpoint (without a trailing slash). Default is https://webexapis.com.

token

({{< req >}}) Webex API access token.

Usage

webexteams.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:

• roomId
• text
• markdown

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

Examples

Send the last reported status to Webex Teams

import "contrib/sranka/webexteams"
import "influxdata/influxdb/secrets"

token = secrets.get(key: "WEBEX_API_KEY")

from(bucket: "example-bucket")
    |> range(start: -1m)
    |> filter(fn: (r) => r._measurement == "statuses")
    |> last()
    |> tableFind(fn: (key) => true)
    |> webexteams.endpoint(token: token)(
        mapFn: (r) =>
            ({
                roomId: "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
                text: "",
                markdown: "Disk usage is **${r.status}**.",
            }),
    )